Documentation
¶
Overview ¶
Package bytehouseiface provides an interface to enable mocking the BYTEHOUSE 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 BYTEHOUSE
- func (c *BYTEHOUSE) CreateDatabase(input *CreateDatabaseInput) (*CreateDatabaseOutput, error)
- func (c *BYTEHOUSE) CreateDatabaseCommon(input *map[string]interface{}) (*map[string]interface{}, error)
- func (c *BYTEHOUSE) CreateDatabaseCommonRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})
- func (c *BYTEHOUSE) CreateDatabaseCommonWithContext(ctx volcengine.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)
- func (c *BYTEHOUSE) CreateDatabaseRequest(input *CreateDatabaseInput) (req *request.Request, output *CreateDatabaseOutput)
- func (c *BYTEHOUSE) CreateDatabaseWithContext(ctx volcengine.Context, input *CreateDatabaseInput, opts ...request.Option) (*CreateDatabaseOutput, error)
- type BYTEHOUSEAPI
- type CreateDatabaseInput
- type CreateDatabaseOutput
- type DataForCreateDatabaseOutput
Constants ¶
const ( ServiceName = "bytehouse" // Name of service. EndpointsID = ServiceName // ID to lookup a service endpoint with. ServiceID = "bytehouse" // ServiceID is a unique identifer of a specific service. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BYTEHOUSE ¶
BYTEHOUSE provides the API operation methods for making requests to BYTEHOUSE. See this package's package overview docs for details on the service.
BYTEHOUSE 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) *BYTEHOUSE
New create int can support ssl or region locate set
func (*BYTEHOUSE) CreateDatabase ¶
func (c *BYTEHOUSE) CreateDatabase(input *CreateDatabaseInput) (*CreateDatabaseOutput, error)
CreateDatabase API operation for BYTEHOUSE.
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 BYTEHOUSE's API operation CreateDatabase for usage and error information.
func (*BYTEHOUSE) CreateDatabaseCommon ¶
func (c *BYTEHOUSE) CreateDatabaseCommon(input *map[string]interface{}) (*map[string]interface{}, error)
CreateDatabaseCommon API operation for BYTEHOUSE.
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 BYTEHOUSE's API operation CreateDatabaseCommon for usage and error information.
func (*BYTEHOUSE) CreateDatabaseCommonRequest ¶
func (c *BYTEHOUSE) CreateDatabaseCommonRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})
CreateDatabaseCommonRequest generates a "volcengine/request.Request" representing the client's request for the CreateDatabaseCommon operation. The "output" return value will be populated with the CreateDatabaseCommon request's response once the request completes successfully.
Use "Send" method on the returned CreateDatabaseCommon Request to send the API call to the service. the "output" return value is not valid until after CreateDatabaseCommon Send returns without error.
See CreateDatabaseCommon for more information on using the CreateDatabaseCommon API call, and error handling.
// Example sending a request using the CreateDatabaseCommonRequest method.
req, resp := client.CreateDatabaseCommonRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (*BYTEHOUSE) CreateDatabaseCommonWithContext ¶
func (c *BYTEHOUSE) CreateDatabaseCommonWithContext(ctx volcengine.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)
CreateDatabaseCommonWithContext is the same as CreateDatabaseCommon with the addition of the ability to pass a context and additional request options.
See CreateDatabaseCommon 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 (*BYTEHOUSE) CreateDatabaseRequest ¶
func (c *BYTEHOUSE) CreateDatabaseRequest(input *CreateDatabaseInput) (req *request.Request, output *CreateDatabaseOutput)
CreateDatabaseRequest generates a "volcengine/request.Request" representing the client's request for the CreateDatabase operation. The "output" return value will be populated with the CreateDatabaseCommon request's response once the request completes successfully.
Use "Send" method on the returned CreateDatabaseCommon Request to send the API call to the service. the "output" return value is not valid until after CreateDatabaseCommon Send returns without error.
See CreateDatabase for more information on using the CreateDatabase API call, and error handling.
// Example sending a request using the CreateDatabaseRequest method.
req, resp := client.CreateDatabaseRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (*BYTEHOUSE) CreateDatabaseWithContext ¶
func (c *BYTEHOUSE) CreateDatabaseWithContext(ctx volcengine.Context, input *CreateDatabaseInput, opts ...request.Option) (*CreateDatabaseOutput, error)
CreateDatabaseWithContext is the same as CreateDatabase with the addition of the ability to pass a context and additional request options.
See CreateDatabase 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 BYTEHOUSEAPI ¶
type BYTEHOUSEAPI interface {
CreateDatabaseCommon(*map[string]interface{}) (*map[string]interface{}, error)
CreateDatabaseCommonWithContext(volcengine.Context, *map[string]interface{}, ...request.Option) (*map[string]interface{}, error)
CreateDatabaseCommonRequest(*map[string]interface{}) (*request.Request, *map[string]interface{})
CreateDatabase(*CreateDatabaseInput) (*CreateDatabaseOutput, error)
CreateDatabaseWithContext(volcengine.Context, *CreateDatabaseInput, ...request.Option) (*CreateDatabaseOutput, error)
CreateDatabaseRequest(*CreateDatabaseInput) (*request.Request, *CreateDatabaseOutput)
}
BYTEHOUSEAPI provides an interface to enable mocking the bytehouse.BYTEHOUSE service client's API operation,
// volcengine sdk func uses an SDK service client to make a request to
// BYTEHOUSE.
func myFunc(svc BYTEHOUSEAPI) bool {
// Make svc.CreateDatabase request
}
func main() {
sess := session.New()
svc := bytehouse.New(sess)
myFunc(svc)
}
type CreateDatabaseInput ¶
type CreateDatabaseInput struct {
Description *string `type:"string" json:",omitempty"`
// Name is a required field
Name *string `min:"1" type:"string" json:",omitempty" required:"true"`
// contains filtered or unexported fields
}
func (CreateDatabaseInput) GoString ¶
func (s CreateDatabaseInput) GoString() string
GoString returns the string representation
func (*CreateDatabaseInput) SetDescription ¶
func (s *CreateDatabaseInput) SetDescription(v string) *CreateDatabaseInput
SetDescription sets the Description field's value.
func (*CreateDatabaseInput) SetName ¶
func (s *CreateDatabaseInput) SetName(v string) *CreateDatabaseInput
SetName sets the Name field's value.
func (CreateDatabaseInput) String ¶
func (s CreateDatabaseInput) String() string
String returns the string representation
func (*CreateDatabaseInput) Validate ¶
func (s *CreateDatabaseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDatabaseOutput ¶
type CreateDatabaseOutput struct {
Metadata *response.ResponseMetadata
Data *DataForCreateDatabaseOutput `type:"structure" json:",omitempty"`
// contains filtered or unexported fields
}
func (CreateDatabaseOutput) GoString ¶
func (s CreateDatabaseOutput) GoString() string
GoString returns the string representation
func (*CreateDatabaseOutput) SetData ¶
func (s *CreateDatabaseOutput) SetData(v *DataForCreateDatabaseOutput) *CreateDatabaseOutput
SetData sets the Data field's value.
func (CreateDatabaseOutput) String ¶
func (s CreateDatabaseOutput) String() string
String returns the string representation
type DataForCreateDatabaseOutput ¶
type DataForCreateDatabaseOutput struct {
UUID *string `type:"string" json:",omitempty"`
// contains filtered or unexported fields
}
func (DataForCreateDatabaseOutput) GoString ¶
func (s DataForCreateDatabaseOutput) GoString() string
GoString returns the string representation
func (*DataForCreateDatabaseOutput) SetUUID ¶
func (s *DataForCreateDatabaseOutput) SetUUID(v string) *DataForCreateDatabaseOutput
SetUUID sets the UUID field's value.
func (DataForCreateDatabaseOutput) String ¶
func (s DataForCreateDatabaseOutput) String() string
String returns the string representation
Source Files