veiapi

Documentation

Overview

Package veiapiiface provides an interface to enable mocking the VEI_API service client for testing your code.

It is important to note that this interface will have breaking changes when the service model is updated and adds new API operations, paginators, and waiters.

Index

• Constants
• type CreateSNInOneStepInput
  • func (s CreateSNInOneStepInput) GoString() string
  • func (s *CreateSNInOneStepInput) SetAuto_renew(v bool) *CreateSNInOneStepInput
  • func (s *CreateSNInOneStepInput) SetCount_of_month(v int32) *CreateSNInOneStepInput
  • func (s *CreateSNInOneStepInput) SetType(v int32) *CreateSNInOneStepInput
  • func (s CreateSNInOneStepInput) String() string
  • func (s *CreateSNInOneStepInput) Validate() error
• type CreateSNInOneStepOutput
  • func (s CreateSNInOneStepOutput) GoString() string
  • func (s *CreateSNInOneStepOutput) SetNode_id(v string) *CreateSNInOneStepOutput
  • func (s *CreateSNInOneStepOutput) SetSn(v string) *CreateSNInOneStepOutput
  • func (s CreateSNInOneStepOutput) String() string
• type VEIAPI
  • func New(p client.ConfigProvider, cfgs ...*volcengine.Config) *VEIAPI
  • func (c *VEIAPI) CreateSNInOneStep(input *CreateSNInOneStepInput) (*CreateSNInOneStepOutput, error)
  • func (c *VEIAPI) CreateSNInOneStepCommon(input *map[string]interface{}) (*map[string]interface{}, error)
  • func (c *VEIAPI) CreateSNInOneStepCommonRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})
  • func (c *VEIAPI) CreateSNInOneStepCommonWithContext(ctx volcengine.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)
  • func (c *VEIAPI) CreateSNInOneStepRequest(input *CreateSNInOneStepInput) (req *request.Request, output *CreateSNInOneStepOutput)
  • func (c *VEIAPI) CreateSNInOneStepWithContext(ctx volcengine.Context, input *CreateSNInOneStepInput, opts ...request.Option) (*CreateSNInOneStepOutput, error)
• type VEIAPIAPI

Constants

const (
	ServiceName = "vei_api"   // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "vei_api"   // ServiceID is a unique identifer of a specific service.
)

Service information constants

Types

type CreateSNInOneStepInput

type CreateSNInOneStepInput struct {
	Auto_renew *bool `type:"boolean" json:"auto_renew"`

	// Count_of_month is a required field
	Count_of_month *int32 `type:"int32" json:"count_of_month" required:"true"`

	// Type is a required field
	Type *int32 `type:"int32" json:"type" required:"true"`
	// contains filtered or unexported fields
}

func (CreateSNInOneStepInput) GoString

func (s CreateSNInOneStepInput) GoString() string

GoString returns the string representation

func (*CreateSNInOneStepInput) SetAuto_renew

func (s *CreateSNInOneStepInput) SetAuto_renew(v bool) *CreateSNInOneStepInput

SetAuto_renew sets the Auto_renew field's value.

func (*CreateSNInOneStepInput) SetCount_of_month

func (s *CreateSNInOneStepInput) SetCount_of_month(v int32) *CreateSNInOneStepInput

SetCount_of_month sets the Count_of_month field's value.

func (*CreateSNInOneStepInput) SetType

func (s *CreateSNInOneStepInput) SetType(v int32) *CreateSNInOneStepInput

SetType sets the Type field's value.

func (CreateSNInOneStepInput) String

func (s CreateSNInOneStepInput) String() string

String returns the string representation

func (*CreateSNInOneStepInput) Validate

func (s *CreateSNInOneStepInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSNInOneStepOutput

type CreateSNInOneStepOutput struct {
	Metadata *response.ResponseMetadata

	Node_id *string `type:"string" json:"node_id"`

	Sn *string `type:"string" json:"sn"`
	// contains filtered or unexported fields
}

func (CreateSNInOneStepOutput) GoString

func (s CreateSNInOneStepOutput) GoString() string

GoString returns the string representation

func (*CreateSNInOneStepOutput) SetNode_id

func (s *CreateSNInOneStepOutput) SetNode_id(v string) *CreateSNInOneStepOutput

SetNode_id sets the Node_id field's value.

func (*CreateSNInOneStepOutput) SetSn

func (s *CreateSNInOneStepOutput) SetSn(v string) *CreateSNInOneStepOutput

SetSn sets the Sn field's value.

func (CreateSNInOneStepOutput) String

func (s CreateSNInOneStepOutput) String() string

String returns the string representation

type VEIAPI

type VEIAPI struct {
	*client.Client
}

VEIAPI provides the API operation methods for making requests to VEI_API. See this package's package overview docs for details on the service.

VEIAPI methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*volcengine.Config) *VEIAPI

New create int can support ssl or region locate set

func (*VEIAPI) CreateSNInOneStep

func (c *VEIAPI) CreateSNInOneStep(input *CreateSNInOneStepInput) (*CreateSNInOneStepOutput, error)

CreateSNInOneStep API operation for VEI_API.

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 VEI_API's API operation CreateSNInOneStep for usage and error information.

func (*VEIAPI) CreateSNInOneStepCommon

func (c *VEIAPI) CreateSNInOneStepCommon(input *map[string]interface{}) (*map[string]interface{}, error)

CreateSNInOneStepCommon API operation for VEI_API.

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 VEI_API's API operation CreateSNInOneStepCommon for usage and error information.

func (*VEIAPI) CreateSNInOneStepCommonRequest

func (c *VEIAPI) CreateSNInOneStepCommonRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})

CreateSNInOneStepCommonRequest generates a "volcengine/request.Request" representing the client's request for the CreateSNInOneStepCommon operation. The "output" return value will be populated with the CreateSNInOneStepCommon request's response once the request completes successfully.

Use "Send" method on the returned CreateSNInOneStepCommon Request to send the API call to the service. the "output" return value is not valid until after CreateSNInOneStepCommon Send returns without error.

See CreateSNInOneStepCommon for more information on using the CreateSNInOneStepCommon API call, and error handling.

// Example sending a request using the CreateSNInOneStepCommonRequest method.
req, resp := client.CreateSNInOneStepCommonRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*VEIAPI) CreateSNInOneStepCommonWithContext

func (c *VEIAPI) CreateSNInOneStepCommonWithContext(ctx volcengine.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)

CreateSNInOneStepCommonWithContext is the same as CreateSNInOneStepCommon with the addition of the ability to pass a context and additional request options.

See CreateSNInOneStepCommon 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 (*VEIAPI) CreateSNInOneStepRequest

func (c *VEIAPI) CreateSNInOneStepRequest(input *CreateSNInOneStepInput) (req *request.Request, output *CreateSNInOneStepOutput)

CreateSNInOneStepRequest generates a "volcengine/request.Request" representing the client's request for the CreateSNInOneStep operation. The "output" return value will be populated with the CreateSNInOneStepCommon request's response once the request completes successfully.

Use "Send" method on the returned CreateSNInOneStepCommon Request to send the API call to the service. the "output" return value is not valid until after CreateSNInOneStepCommon Send returns without error.

See CreateSNInOneStep for more information on using the CreateSNInOneStep API call, and error handling.

// Example sending a request using the CreateSNInOneStepRequest method.
req, resp := client.CreateSNInOneStepRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*VEIAPI) CreateSNInOneStepWithContext

func (c *VEIAPI) CreateSNInOneStepWithContext(ctx volcengine.Context, input *CreateSNInOneStepInput, opts ...request.Option) (*CreateSNInOneStepOutput, error)

CreateSNInOneStepWithContext is the same as CreateSNInOneStep with the addition of the ability to pass a context and additional request options.

See CreateSNInOneStep 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.

type VEIAPIAPI

type VEIAPIAPI interface {
	CreateSNInOneStepCommon(*map[string]interface{}) (*map[string]interface{}, error)
	CreateSNInOneStepCommonWithContext(volcengine.Context, *map[string]interface{}, ...request.Option) (*map[string]interface{}, error)
	CreateSNInOneStepCommonRequest(*map[string]interface{}) (*request.Request, *map[string]interface{})

	CreateSNInOneStep(*CreateSNInOneStepInput) (*CreateSNInOneStepOutput, error)
	CreateSNInOneStepWithContext(volcengine.Context, *CreateSNInOneStepInput, ...request.Option) (*CreateSNInOneStepOutput, error)
	CreateSNInOneStepRequest(*CreateSNInOneStepInput) (*request.Request, *CreateSNInOneStepOutput)
}

VEIAPIAPI provides an interface to enable mocking the veiapi.VEIAPI service client's API operation,

// volcengine sdk func uses an SDK service client to make a request to
// VEI_API.
func myFunc(svc VEIAPIAPI) bool {
    // Make svc.CreateSNInOneStep request
}

func main() {
    sess := session.New()
    svc := veiapi.New(sess)

    myFunc(svc)
}