Documentation
¶
Overview ¶
Package clawsentryiface provides an interface to enable mocking the CLAWSENTRY 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 BaseForCreateClawInput
- type CLAWSENTRY
- func (c *CLAWSENTRY) CreateClaw(input *CreateClawInput) (*CreateClawOutput, error)
- func (c *CLAWSENTRY) CreateClawCommon(input *map[string]interface{}) (*map[string]interface{}, error)
- func (c *CLAWSENTRY) CreateClawCommonRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})
- func (c *CLAWSENTRY) CreateClawCommonWithContext(ctx volcengine.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)
- func (c *CLAWSENTRY) CreateClawRequest(input *CreateClawInput) (req *request.Request, output *CreateClawOutput)
- func (c *CLAWSENTRY) CreateClawWithContext(ctx volcengine.Context, input *CreateClawInput, opts ...request.Option) (*CreateClawOutput, error)
- type CLAWSENTRYAPI
- type CreateClawInput
- func (s CreateClawInput) GoString() string
- func (s *CreateClawInput) SetBase(v *BaseForCreateClawInput) *CreateClawInput
- func (s *CreateClawInput) SetExternalClawID(v string) *CreateClawInput
- func (s *CreateClawInput) SetName(v string) *CreateClawInput
- func (s CreateClawInput) String() string
- func (s *CreateClawInput) Validate() error
- type CreateClawOutput
- func (s CreateClawOutput) GoString() string
- func (s *CreateClawOutput) SetCenterEndpoint(v string) *CreateClawOutput
- func (s *CreateClawOutput) SetClawApiKey(v string) *CreateClawOutput
- func (s *CreateClawOutput) SetClawID(v string) *CreateClawOutput
- func (s *CreateClawOutput) SetConfVersion(v string) *CreateClawOutput
- func (s *CreateClawOutput) SetLumenEndpoint(v string) *CreateClawOutput
- func (s CreateClawOutput) String() string
Constants ¶
const ( ServiceName = "clawsentry" // Name of service. EndpointsID = ServiceName // ID to lookup a service endpoint with. ServiceID = "clawsentry" // ServiceID is a unique identifer of a specific service. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BaseForCreateClawInput ¶
type BaseForCreateClawInput struct {
InstanceID *string `type:"string" json:",omitempty"`
// contains filtered or unexported fields
}
func (BaseForCreateClawInput) GoString ¶
func (s BaseForCreateClawInput) GoString() string
GoString returns the string representation
func (*BaseForCreateClawInput) SetInstanceID ¶
func (s *BaseForCreateClawInput) SetInstanceID(v string) *BaseForCreateClawInput
SetInstanceID sets the InstanceID field's value.
func (BaseForCreateClawInput) String ¶
func (s BaseForCreateClawInput) String() string
String returns the string representation
type CLAWSENTRY ¶
CLAWSENTRY provides the API operation methods for making requests to CLAWSENTRY. See this package's package overview docs for details on the service.
CLAWSENTRY 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) *CLAWSENTRY
New create int can support ssl or region locate set
func (*CLAWSENTRY) CreateClaw ¶
func (c *CLAWSENTRY) CreateClaw(input *CreateClawInput) (*CreateClawOutput, error)
CreateClaw API operation for CLAWSENTRY.
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 CLAWSENTRY's API operation CreateClaw for usage and error information.
func (*CLAWSENTRY) CreateClawCommon ¶
func (c *CLAWSENTRY) CreateClawCommon(input *map[string]interface{}) (*map[string]interface{}, error)
CreateClawCommon API operation for CLAWSENTRY.
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 CLAWSENTRY's API operation CreateClawCommon for usage and error information.
func (*CLAWSENTRY) CreateClawCommonRequest ¶
func (c *CLAWSENTRY) CreateClawCommonRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})
CreateClawCommonRequest generates a "volcengine/request.Request" representing the client's request for the CreateClawCommon operation. The "output" return value will be populated with the CreateClawCommon request's response once the request completes successfully.
Use "Send" method on the returned CreateClawCommon Request to send the API call to the service. the "output" return value is not valid until after CreateClawCommon Send returns without error.
See CreateClawCommon for more information on using the CreateClawCommon API call, and error handling.
// Example sending a request using the CreateClawCommonRequest method.
req, resp := client.CreateClawCommonRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (*CLAWSENTRY) CreateClawCommonWithContext ¶
func (c *CLAWSENTRY) CreateClawCommonWithContext(ctx volcengine.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)
CreateClawCommonWithContext is the same as CreateClawCommon with the addition of the ability to pass a context and additional request options.
See CreateClawCommon 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 (*CLAWSENTRY) CreateClawRequest ¶
func (c *CLAWSENTRY) CreateClawRequest(input *CreateClawInput) (req *request.Request, output *CreateClawOutput)
CreateClawRequest generates a "volcengine/request.Request" representing the client's request for the CreateClaw operation. The "output" return value will be populated with the CreateClawCommon request's response once the request completes successfully.
Use "Send" method on the returned CreateClawCommon Request to send the API call to the service. the "output" return value is not valid until after CreateClawCommon Send returns without error.
See CreateClaw for more information on using the CreateClaw API call, and error handling.
// Example sending a request using the CreateClawRequest method.
req, resp := client.CreateClawRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (*CLAWSENTRY) CreateClawWithContext ¶
func (c *CLAWSENTRY) CreateClawWithContext(ctx volcengine.Context, input *CreateClawInput, opts ...request.Option) (*CreateClawOutput, error)
CreateClawWithContext is the same as CreateClaw with the addition of the ability to pass a context and additional request options.
See CreateClaw 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 CLAWSENTRYAPI ¶
type CLAWSENTRYAPI interface {
CreateClawCommon(*map[string]interface{}) (*map[string]interface{}, error)
CreateClawCommonWithContext(volcengine.Context, *map[string]interface{}, ...request.Option) (*map[string]interface{}, error)
CreateClawCommonRequest(*map[string]interface{}) (*request.Request, *map[string]interface{})
CreateClaw(*CreateClawInput) (*CreateClawOutput, error)
CreateClawWithContext(volcengine.Context, *CreateClawInput, ...request.Option) (*CreateClawOutput, error)
CreateClawRequest(*CreateClawInput) (*request.Request, *CreateClawOutput)
}
CLAWSENTRYAPI provides an interface to enable mocking the clawsentry.CLAWSENTRY service client's API operation,
// volcengine sdk func uses an SDK service client to make a request to
// CLAWSENTRY.
func myFunc(svc CLAWSENTRYAPI) bool {
// Make svc.CreateClaw request
}
func main() {
sess := session.New()
svc := clawsentry.New(sess)
myFunc(svc)
}
type CreateClawInput ¶
type CreateClawInput struct {
Base *BaseForCreateClawInput `type:"structure" json:",omitempty"`
// ExternalClawID is a required field
ExternalClawID *string `min:"1" max:"256" type:"string" json:",omitempty" required:"true"`
Name *string `max:"100" type:"string" json:",omitempty"`
// contains filtered or unexported fields
}
func (CreateClawInput) GoString ¶
func (s CreateClawInput) GoString() string
GoString returns the string representation
func (*CreateClawInput) SetBase ¶
func (s *CreateClawInput) SetBase(v *BaseForCreateClawInput) *CreateClawInput
SetBase sets the Base field's value.
func (*CreateClawInput) SetExternalClawID ¶
func (s *CreateClawInput) SetExternalClawID(v string) *CreateClawInput
SetExternalClawID sets the ExternalClawID field's value.
func (*CreateClawInput) SetName ¶
func (s *CreateClawInput) SetName(v string) *CreateClawInput
SetName sets the Name field's value.
func (CreateClawInput) String ¶
func (s CreateClawInput) String() string
String returns the string representation
func (*CreateClawInput) Validate ¶
func (s *CreateClawInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateClawOutput ¶
type CreateClawOutput struct {
Metadata *response.ResponseMetadata
CenterEndpoint *string `type:"string" json:",omitempty"`
ClawApiKey *string `type:"string" json:",omitempty"`
ClawID *string `type:"string" json:",omitempty"`
ConfVersion *string `type:"string" json:",omitempty"`
LumenEndpoint *string `type:"string" json:",omitempty"`
// contains filtered or unexported fields
}
func (CreateClawOutput) GoString ¶
func (s CreateClawOutput) GoString() string
GoString returns the string representation
func (*CreateClawOutput) SetCenterEndpoint ¶
func (s *CreateClawOutput) SetCenterEndpoint(v string) *CreateClawOutput
SetCenterEndpoint sets the CenterEndpoint field's value.
func (*CreateClawOutput) SetClawApiKey ¶
func (s *CreateClawOutput) SetClawApiKey(v string) *CreateClawOutput
SetClawApiKey sets the ClawApiKey field's value.
func (*CreateClawOutput) SetClawID ¶
func (s *CreateClawOutput) SetClawID(v string) *CreateClawOutput
SetClawID sets the ClawID field's value.
func (*CreateClawOutput) SetConfVersion ¶
func (s *CreateClawOutput) SetConfVersion(v string) *CreateClawOutput
SetConfVersion sets the ConfVersion field's value.
func (*CreateClawOutput) SetLumenEndpoint ¶
func (s *CreateClawOutput) SetLumenEndpoint(v string) *CreateClawOutput
SetLumenEndpoint sets the LumenEndpoint field's value.
func (CreateClawOutput) String ¶
func (s CreateClawOutput) String() string
String returns the string representation