api_modify_snapshot_group.go

// Code generated by volcengine with private/model/cli/gen-api/main.go. DO NOT EDIT.

package storageebs

import (
	"github.com/volcengine/volcengine-go-sdk/volcengine"
	"github.com/volcengine/volcengine-go-sdk/volcengine/request"
	"github.com/volcengine/volcengine-go-sdk/volcengine/response"
	"github.com/volcengine/volcengine-go-sdk/volcengine/volcengineutil"
)

const opModifySnapshotGroupCommon = "ModifySnapshotGroup"

// ModifySnapshotGroupCommonRequest generates a "volcengine/request.Request" representing the
// client's request for the ModifySnapshotGroupCommon operation. The "output" return
// value will be populated with the ModifySnapshotGroupCommon request's response once the request completes
// successfully.
//
// Use "Send" method on the returned ModifySnapshotGroupCommon Request to send the API call to the service.
// the "output" return value is not valid until after ModifySnapshotGroupCommon Send returns without error.
//
// See ModifySnapshotGroupCommon for more information on using the ModifySnapshotGroupCommon
// API call, and error handling.
//
//    // Example sending a request using the ModifySnapshotGroupCommonRequest method.
//    req, resp := client.ModifySnapshotGroupCommonRequest(params)
//
//    err := req.Send()
//    if err == nil { // resp is now filled
//        fmt.Println(resp)
//    }
func (c *STORAGEEBS) ModifySnapshotGroupCommonRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{}) {
	op := &request.Operation{
		Name:       opModifySnapshotGroupCommon,
		HTTPMethod: "GET",
		HTTPPath:   "/",
	}

	if input == nil {
		input = &map[string]interface{}{}
	}

	output = &map[string]interface{}{}
	req = c.newRequest(op, input, output)

	return
}

// ModifySnapshotGroupCommon API operation for STORAGE_EBS.
//
// Returns volcengineerr.Error for service API and SDK errors. Use runtime type assertions
// with volcengineerr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the VOLCENGINE API reference guide for STORAGE_EBS's
// API operation ModifySnapshotGroupCommon for usage and error information.
func (c *STORAGEEBS) ModifySnapshotGroupCommon(input *map[string]interface{}) (*map[string]interface{}, error) {
	req, out := c.ModifySnapshotGroupCommonRequest(input)
	return out, req.Send()
}

// ModifySnapshotGroupCommonWithContext is the same as ModifySnapshotGroupCommon with the addition of
// the ability to pass a context and additional request options.
//
// See ModifySnapshotGroupCommon for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur.
// In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *STORAGEEBS) ModifySnapshotGroupCommonWithContext(ctx volcengine.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error) {
	req, out := c.ModifySnapshotGroupCommonRequest(input)
	req.SetContext(ctx)
	req.ApplyOptions(opts...)
	return out, req.Send()
}

const opModifySnapshotGroup = "ModifySnapshotGroup"

// ModifySnapshotGroupRequest generates a "volcengine/request.Request" representing the
// client's request for the ModifySnapshotGroup operation. The "output" return
// value will be populated with the ModifySnapshotGroupCommon request's response once the request completes
// successfully.
//
// Use "Send" method on the returned ModifySnapshotGroupCommon Request to send the API call to the service.
// the "output" return value is not valid until after ModifySnapshotGroupCommon Send returns without error.
//
// See ModifySnapshotGroup for more information on using the ModifySnapshotGroup
// API call, and error handling.
//
//    // Example sending a request using the ModifySnapshotGroupRequest method.
//    req, resp := client.ModifySnapshotGroupRequest(params)
//
//    err := req.Send()
//    if err == nil { // resp is now filled
//        fmt.Println(resp)
//    }
func (c *STORAGEEBS) ModifySnapshotGroupRequest(input *ModifySnapshotGroupInput) (req *request.Request, output *ModifySnapshotGroupOutput) {
	op := &request.Operation{
		Name:       opModifySnapshotGroup,
		HTTPMethod: "GET",
		HTTPPath:   "/",
	}

	if input == nil {
		input = &ModifySnapshotGroupInput{}
	}

	output = &ModifySnapshotGroupOutput{}
	req = c.newRequest(op, input, output)

	return
}

// ModifySnapshotGroup API operation for STORAGE_EBS.
//
// Returns volcengineerr.Error for service API and SDK errors. Use runtime type assertions
// with volcengineerr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the VOLCENGINE API reference guide for STORAGE_EBS's
// API operation ModifySnapshotGroup for usage and error information.
func (c *STORAGEEBS) ModifySnapshotGroup(input *ModifySnapshotGroupInput) (*ModifySnapshotGroupOutput, error) {
	req, out := c.ModifySnapshotGroupRequest(input)
	return out, req.Send()
}

// ModifySnapshotGroupWithContext is the same as ModifySnapshotGroup with the addition of
// the ability to pass a context and additional request options.
//
// See ModifySnapshotGroup for details on how to use this API operation.
//
// The context must be non-nil and will be used for request cancellation. Ifthe context is nil a panic will occur.
// In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/
// for more information on using Contexts.
func (c *STORAGEEBS) ModifySnapshotGroupWithContext(ctx volcengine.Context, input *ModifySnapshotGroupInput, opts ...request.Option) (*ModifySnapshotGroupOutput, error) {
	req, out := c.ModifySnapshotGroupRequest(input)
	req.SetContext(ctx)
	req.ApplyOptions(opts...)
	return out, req.Send()
}

type ModifySnapshotGroupInput struct {
	_ struct{} `type:"structure"`

	Description *string `type:"string"`

	Name *string `type:"string"`

	// SnapshotGroupId is a required field
	SnapshotGroupId *string `type:"string" required:"true"`
}

// String returns the string representation
func (s ModifySnapshotGroupInput) String() string {
	return volcengineutil.Prettify(s)
}

// GoString returns the string representation
func (s ModifySnapshotGroupInput) GoString() string {
	return s.String()
}

// Validate inspects the fields of the type to determine if they are valid.
func (s *ModifySnapshotGroupInput) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "ModifySnapshotGroupInput"}
	if s.SnapshotGroupId == nil {
		invalidParams.Add(request.NewErrParamRequired("SnapshotGroupId"))
	}

	if invalidParams.Len() > 0 {
		return invalidParams
	}
	return nil
}

// SetDescription sets the Description field's value.
func (s *ModifySnapshotGroupInput) SetDescription(v string) *ModifySnapshotGroupInput {
	s.Description = &v
	return s
}

// SetName sets the Name field's value.
func (s *ModifySnapshotGroupInput) SetName(v string) *ModifySnapshotGroupInput {
	s.Name = &v
	return s
}

// SetSnapshotGroupId sets the SnapshotGroupId field's value.
func (s *ModifySnapshotGroupInput) SetSnapshotGroupId(v string) *ModifySnapshotGroupInput {
	s.SnapshotGroupId = &v
	return s
}

type ModifySnapshotGroupOutput struct {
	_ struct{} `type:"structure"`

	Metadata *response.ResponseMetadata
}

// String returns the string representation
func (s ModifySnapshotGroupOutput) String() string {
	return volcengineutil.Prettify(s)
}

// GoString returns the string representation
func (s ModifySnapshotGroupOutput) GoString() string {
	return s.String()
}