api_describe_databases.go

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

package rdsmysqlv2

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 opDescribeDatabasesCommon = "DescribeDatabases"

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

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

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

	req.HTTPRequest.Header.Set("Content-Type", "application/json; charset=utf-8")

	return
}

// DescribeDatabasesCommon API operation for RDS_MYSQL_V2.
//
// 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 RDS_MYSQL_V2's
// API operation DescribeDatabasesCommon for usage and error information.
func (c *RDSMYSQLV2) DescribeDatabasesCommon(input *map[string]interface{}) (*map[string]interface{}, error) {
	req, out := c.DescribeDatabasesCommonRequest(input)
	return out, req.Send()
}

// DescribeDatabasesCommonWithContext is the same as DescribeDatabasesCommon with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeDatabasesCommon 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 *RDSMYSQLV2) DescribeDatabasesCommonWithContext(ctx volcengine.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error) {
	req, out := c.DescribeDatabasesCommonRequest(input)
	req.SetContext(ctx)
	req.ApplyOptions(opts...)
	return out, req.Send()
}

const opDescribeDatabases = "DescribeDatabases"

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

	if input == nil {
		input = &DescribeDatabasesInput{}
	}

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

	req.HTTPRequest.Header.Set("Content-Type", "application/json; charset=utf-8")

	return
}

// DescribeDatabases API operation for RDS_MYSQL_V2.
//
// 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 RDS_MYSQL_V2's
// API operation DescribeDatabases for usage and error information.
func (c *RDSMYSQLV2) DescribeDatabases(input *DescribeDatabasesInput) (*DescribeDatabasesOutput, error) {
	req, out := c.DescribeDatabasesRequest(input)
	return out, req.Send()
}

// DescribeDatabasesWithContext is the same as DescribeDatabases with the addition of
// the ability to pass a context and additional request options.
//
// See DescribeDatabases 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 *RDSMYSQLV2) DescribeDatabasesWithContext(ctx volcengine.Context, input *DescribeDatabasesInput, opts ...request.Option) (*DescribeDatabasesOutput, error) {
	req, out := c.DescribeDatabasesRequest(input)
	req.SetContext(ctx)
	req.ApplyOptions(opts...)
	return out, req.Send()
}

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

	CharacterSetName *string `type:"string"`

	DBDesc *string `type:"string"`

	DBName *string `type:"string"`

	DBStatus *string `type:"string"`

	DatabasePrivileges []*DatabasePrivilegeForDescribeDatabasesOutput `type:"list"`
}

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

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

// SetCharacterSetName sets the CharacterSetName field's value.
func (s *DatabaseForDescribeDatabasesOutput) SetCharacterSetName(v string) *DatabaseForDescribeDatabasesOutput {
	s.CharacterSetName = &v
	return s
}

// SetDBDesc sets the DBDesc field's value.
func (s *DatabaseForDescribeDatabasesOutput) SetDBDesc(v string) *DatabaseForDescribeDatabasesOutput {
	s.DBDesc = &v
	return s
}

// SetDBName sets the DBName field's value.
func (s *DatabaseForDescribeDatabasesOutput) SetDBName(v string) *DatabaseForDescribeDatabasesOutput {
	s.DBName = &v
	return s
}

// SetDBStatus sets the DBStatus field's value.
func (s *DatabaseForDescribeDatabasesOutput) SetDBStatus(v string) *DatabaseForDescribeDatabasesOutput {
	s.DBStatus = &v
	return s
}

// SetDatabasePrivileges sets the DatabasePrivileges field's value.
func (s *DatabaseForDescribeDatabasesOutput) SetDatabasePrivileges(v []*DatabasePrivilegeForDescribeDatabasesOutput) *DatabaseForDescribeDatabasesOutput {
	s.DatabasePrivileges = v
	return s
}

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

	AccountName *string `type:"string"`

	AccountPrivilege *string `type:"string"`

	AccountPrivilegeDetail *string `type:"string"`

	Host *string `type:"string"`
}

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

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

// SetAccountName sets the AccountName field's value.
func (s *DatabasePrivilegeForDescribeDatabasesOutput) SetAccountName(v string) *DatabasePrivilegeForDescribeDatabasesOutput {
	s.AccountName = &v
	return s
}

// SetAccountPrivilege sets the AccountPrivilege field's value.
func (s *DatabasePrivilegeForDescribeDatabasesOutput) SetAccountPrivilege(v string) *DatabasePrivilegeForDescribeDatabasesOutput {
	s.AccountPrivilege = &v
	return s
}

// SetAccountPrivilegeDetail sets the AccountPrivilegeDetail field's value.
func (s *DatabasePrivilegeForDescribeDatabasesOutput) SetAccountPrivilegeDetail(v string) *DatabasePrivilegeForDescribeDatabasesOutput {
	s.AccountPrivilegeDetail = &v
	return s
}

// SetHost sets the Host field's value.
func (s *DatabasePrivilegeForDescribeDatabasesOutput) SetHost(v string) *DatabasePrivilegeForDescribeDatabasesOutput {
	s.Host = &v
	return s
}

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

	DBName *string `type:"string"`

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

	PageNumber *int32 `type:"int32"`

	PageSize *int32 `type:"int32"`
}

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

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

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

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

// SetDBName sets the DBName field's value.
func (s *DescribeDatabasesInput) SetDBName(v string) *DescribeDatabasesInput {
	s.DBName = &v
	return s
}

// SetInstanceId sets the InstanceId field's value.
func (s *DescribeDatabasesInput) SetInstanceId(v string) *DescribeDatabasesInput {
	s.InstanceId = &v
	return s
}

// SetPageNumber sets the PageNumber field's value.
func (s *DescribeDatabasesInput) SetPageNumber(v int32) *DescribeDatabasesInput {
	s.PageNumber = &v
	return s
}

// SetPageSize sets the PageSize field's value.
func (s *DescribeDatabasesInput) SetPageSize(v int32) *DescribeDatabasesInput {
	s.PageSize = &v
	return s
}

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

	Metadata *response.ResponseMetadata

	Databases []*DatabaseForDescribeDatabasesOutput `type:"list"`

	Total *int32 `type:"int32"`
}

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

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

// SetDatabases sets the Databases field's value.
func (s *DescribeDatabasesOutput) SetDatabases(v []*DatabaseForDescribeDatabasesOutput) *DescribeDatabasesOutput {
	s.Databases = v
	return s
}

// SetTotal sets the Total field's value.
func (s *DescribeDatabasesOutput) SetTotal(v int32) *DescribeDatabasesOutput {
	s.Total = &v
	return s
}