client

package
v2.1.11 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 20, 2025 License: Apache-2.0 Imports: 8 Imported by: 1,381

Documentation

Overview

This file is auto-generated, don't edit it. Thanks.

This file is auto-generated, don't edit it. Thanks.

This file is auto-generated, don't edit it. Thanks.

This file is auto-generated, don't edit it. Thanks.

This file is auto-generated, don't edit it. Thanks.

This file is auto-generated, don't edit it. Thanks.

This file is auto-generated, don't edit it. Thanks.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AlibabaCloudError added in v2.1.0 

type AlibabaCloudError struct {
	RetryAfter         *int64                 ``
	Data               map[string]interface{} ``
	AccessDeniedDetail map[string]interface{} ``
	Name               *string                ``
	Stack              *string                ``
	StatusCode         *int                   ``
	Code               *string                ``
	Message            *string                ``
	Description        *string                ``
	RequestId          *string                ``
}

func (AlibabaCloudError) Error added in v2.1.0 

func (err AlibabaCloudError) Error() string

func (*AlibabaCloudError) GetAccessDeniedDetail added in v2.1.6 

func (s *AlibabaCloudError) GetAccessDeniedDetail() map[string]interface{}

func (*AlibabaCloudError) GetCode added in v2.1.0 

func (s *AlibabaCloudError) GetCode() *string

func (*AlibabaCloudError) GetData added in v2.1.6 

func (s *AlibabaCloudError) GetData() map[string]interface{}

func (*AlibabaCloudError) GetDescription added in v2.1.0 

func (s *AlibabaCloudError) GetDescription() *string

func (*AlibabaCloudError) GetMessage added in v2.1.0 

func (s *AlibabaCloudError) GetMessage() *string

func (*AlibabaCloudError) GetName added in v2.1.0 

func (s *AlibabaCloudError) GetName() *string

func (*AlibabaCloudError) GetRequestId added in v2.1.0 

func (s *AlibabaCloudError) GetRequestId() *string

func (*AlibabaCloudError) GetRetryAfter added in v2.1.0 

func (s *AlibabaCloudError) GetRetryAfter() *int64

func (*AlibabaCloudError) GetStack added in v2.1.0 

func (s *AlibabaCloudError) GetStack() *string

func (*AlibabaCloudError) GetStatusCode added in v2.1.0 

func (s *AlibabaCloudError) GetStatusCode() *int

type Client 

type Client struct {
	DisableSDKError      *bool
	Endpoint             *string
	RegionId             *string
	Protocol             *string
	Method               *string
	UserAgent            *string
	EndpointRule         *string
	EndpointMap          map[string]*string
	Suffix               *string
	ReadTimeout          *int
	ConnectTimeout       *int
	HttpProxy            *string
	HttpsProxy           *string
	Socks5Proxy          *string
	Socks5NetWork        *string
	NoProxy              *string
	Network              *string
	ProductId            *string
	MaxIdleConns         *int
	EndpointType         *string
	OpenPlatformEndpoint *string
	Credential           credential.Credential
	SignatureVersion     *string
	SignatureAlgorithm   *string
	Headers              map[string]*string
	Spi                  spi.ClientInterface
	GlobalParameters     *openapiutil.GlobalParameters
	Key                  *string
	Cert                 *string
	Ca                   *string
	DisableHttp2         *bool
	RetryOptions         *dara.RetryOptions
	HttpClient           dara.HttpClient
	TlsMinVersion        *string
	AttributeMap         *spi.AttributeMap
}

func NewClient 

func NewClient(config *openapiutil.Config) (*Client, error)

Description:

Init client with Config

@param config - config contains the necessary information to create a client

func (*Client) CallApi 

func (client *Client) CallApi(params *openapiutil.Params, request *openapiutil.OpenApiRequest, runtime *dara.RuntimeOptions) (_result map[string]interface{}, _err error)

func (*Client) CallApiWithCtx added in v2.1.9 

func (client *Client) CallApiWithCtx(ctx context.Context, params *openapiutil.Params, request *openapiutil.OpenApiRequest, runtime *dara.RuntimeOptions) (_result map[string]interface{}, _err error)

func (*Client) CallSSEApi added in v2.1.0 

func (client *Client) CallSSEApi(params *openapiutil.Params, request *openapiutil.OpenApiRequest, runtime *dara.RuntimeOptions, _yield chan *SSEResponse, _yieldErr chan error)

func (*Client) CallSSEApiWithCtx added in v2.1.9 

func (client *Client) CallSSEApiWithCtx(ctx context.Context, params *openapiutil.Params, request *openapiutil.OpenApiRequest, runtime *dara.RuntimeOptions, _yield chan *SSEResponse, _yieldErr chan error)

func (*Client) CheckConfig 

func (client *Client) CheckConfig(config *openapiutil.Config) (_err error)

Description:

If the endpointRule and config.endpoint are empty, throw error

@param config - config contains the necessary information to create a client

func (*Client) DoROAFormRequestWithCtx added in v2.1.9 

func (client *Client) DoROAFormRequestWithCtx(ctx context.Context, action *string, version *string, protocol *string, method *string, authType *string, pathname *string, bodyType *string, request *openapiutil.OpenApiRequest, runtime *dara.RuntimeOptions) (_result map[string]interface{}, _err error)

Description:

Encapsulate the request and invoke the network with form body

@param action - api name

@param version - product version

@param protocol - http or https

@param method - e.g. GET

@param authType - authorization type e.g. AK

@param pathname - pathname of every api

@param bodyType - response body type e.g. String

@param request - object of OpenApiRequest

@param runtime - which controls some details of call api, such as retry times

@return the response

func (*Client) DoROARequest 

func (client *Client) DoROARequest(action *string, version *string, protocol *string, method *string, authType *string, pathname *string, bodyType *string, request *openapiutil.OpenApiRequest, runtime *dara.RuntimeOptions) (_result map[string]interface{}, _err error)

Description:

Encapsulate the request and invoke the network

@param action - api name

@param version - product version

@param protocol - http or https

@param method - e.g. GET

@param authType - authorization type e.g. AK

@param pathname - pathname of every api

@param bodyType - response body type e.g. String

@param request - object of OpenApiRequest

@param runtime - which controls some details of call api, such as retry times

@return the response

func (*Client) DoROARequestWithCtx added in v2.1.9 

func (client *Client) DoROARequestWithCtx(ctx context.Context, action *string, version *string, protocol *string, method *string, authType *string, pathname *string, bodyType *string, request *openapiutil.OpenApiRequest, runtime *dara.RuntimeOptions) (_result map[string]interface{}, _err error)

Description:

Encapsulate the request and invoke the network

@param action - api name

@param version - product version

@param protocol - http or https

@param method - e.g. GET

@param authType - authorization type e.g. AK

@param pathname - pathname of every api

@param bodyType - response body type e.g. String

@param request - object of OpenApiRequest

@param runtime - which controls some details of call api, such as retry times

@return the response

func (*Client) DoROARequestWithForm 

func (client *Client) DoROARequestWithForm(action *string, version *string, protocol *string, method *string, authType *string, pathname *string, bodyType *string, request *openapiutil.OpenApiRequest, runtime *dara.RuntimeOptions) (_result map[string]interface{}, _err error)

Description:

Encapsulate the request and invoke the network with form body

@param action - api name

@param version - product version

@param protocol - http or https

@param method - e.g. GET

@param authType - authorization type e.g. AK

@param pathname - pathname of every api

@param bodyType - response body type e.g. String

@param request - object of OpenApiRequest

@param runtime - which controls some details of call api, such as retry times

@return the response

func (*Client) DoRPCRequest 

func (client *Client) DoRPCRequest(action *string, version *string, protocol *string, method *string, authType *string, bodyType *string, request *openapiutil.OpenApiRequest, runtime *dara.RuntimeOptions) (_result map[string]interface{}, _err error)

Description:

Encapsulate the request and invoke the network

@param action - api name

@param version - product version

@param protocol - http or https

@param method - e.g. GET

@param authType - authorization type e.g. AK

@param bodyType - response body type e.g. String

@param request - object of OpenApiRequest

@param runtime - which controls some details of call api, such as retry times

@return the response

func (*Client) DoRPCRequestWithCtx added in v2.1.9 

func (client *Client) DoRPCRequestWithCtx(ctx context.Context, action *string, version *string, protocol *string, method *string, authType *string, bodyType *string, request *openapiutil.OpenApiRequest, runtime *dara.RuntimeOptions) (_result map[string]interface{}, _err error)

Description:

Encapsulate the request and invoke the network

@param action - api name

@param version - product version

@param protocol - http or https

@param method - e.g. GET

@param authType - authorization type e.g. AK

@param bodyType - response body type e.g. String

@param request - object of OpenApiRequest

@param runtime - which controls some details of call api, such as retry times

@return the response

func (*Client) DoRequest 

func (client *Client) DoRequest(params *openapiutil.Params, request *openapiutil.OpenApiRequest, runtime *dara.RuntimeOptions) (_result map[string]interface{}, _err error)

Description:

Encapsulate the request and invoke the network

@param action - api name

@param version - product version

@param protocol - http or https

@param method - e.g. GET

@param authType - authorization type e.g. AK

@param bodyType - response body type e.g. String

@param request - object of OpenApiRequest

@param runtime - which controls some details of call api, such as retry times

@return the response

func (*Client) DoRequestWithCtx added in v2.1.9 

func (client *Client) DoRequestWithCtx(ctx context.Context, params *openapiutil.Params, request *openapiutil.OpenApiRequest, runtime *dara.RuntimeOptions) (_result map[string]interface{}, _err error)

Description:

Encapsulate the request and invoke the network

@param action - api name

@param version - product version

@param protocol - http or https

@param method - e.g. GET

@param authType - authorization type e.g. AK

@param bodyType - response body type e.g. String

@param request - object of OpenApiRequest

@param runtime - which controls some details of call api, such as retry times

@return the response

func (*Client) Execute 

func (client *Client) Execute(params *openapiutil.Params, request *openapiutil.OpenApiRequest, runtime *dara.RuntimeOptions) (_result map[string]interface{}, _err error)

Description:

Encapsulate the request and invoke the network

@param action - api name

@param version - product version

@param protocol - http or https

@param method - e.g. GET

@param authType - authorization type e.g. AK

@param bodyType - response body type e.g. String

@param request - object of OpenApiRequest

@param runtime - which controls some details of call api, such as retry times

@return the response

func (*Client) ExecuteWithCtx added in v2.1.9 

func (client *Client) ExecuteWithCtx(ctx context.Context, params *openapiutil.Params, request *openapiutil.OpenApiRequest, runtime *dara.RuntimeOptions) (_result map[string]interface{}, _err error)

Description:

Encapsulate the request and invoke the network

@param action - api name

@param version - product version

@param protocol - http or https

@param method - e.g. GET

@param authType - authorization type e.g. AK

@param bodyType - response body type e.g. String

@param request - object of OpenApiRequest

@param runtime - which controls some details of call api, such as retry times

@return the response

func (*Client) GetAccessDeniedDetail added in v2.1.0 

func (client *Client) GetAccessDeniedDetail(err map[string]interface{}) (_result map[string]interface{})

func (*Client) GetAccessKeyId 

func (client *Client) GetAccessKeyId() (_result *string, _err error)

Description:

Get accesskey id by using credential

@return accesskey id

func (*Client) GetAccessKeySecret 

func (client *Client) GetAccessKeySecret() (_result *string, _err error)

Description:

Get accesskey secret by using credential

@return accesskey secret

func (*Client) GetBearerToken 

func (client *Client) GetBearerToken() (_result *string, _err error)

Description:

Get bearer token by credential

@return bearer token

func (*Client) GetRpcHeaders 

func (client *Client) GetRpcHeaders() (_result map[string]*string, _err error)

Description:

get RPC header for debug

func (*Client) GetSecurityToken 

func (client *Client) GetSecurityToken() (_result *string, _err error)

Description:

Get security token by using credential

@return security token

func (*Client) GetType 

func (client *Client) GetType() (_result *string, _err error)

Description:

Get credential type by credential

@return credential type e.g. access_key

func (*Client) Init 

func (client *Client) Init(config *openapiutil.Config) (_err error)

func (*Client) SetGatewayClient added in v2.0.2 

func (client *Client) SetGatewayClient(spi spi.ClientInterface) (_err error)

Description:

set gateway client

@param spi - .

func (*Client) SetRpcHeaders 

func (client *Client) SetRpcHeaders(headers map[string]*string) (_err error)

Description:

set RPC header for debug

@param headers - headers for debug, this header can be used only once.

type ClientError added in v2.1.0 

type ClientError struct {
	StatusCode         *int                   ``
	Code               *string                ``
	Message            *string                ``
	Description        *string                ``
	RequestId          *string                ``
	RetryAfter         *int64                 ``
	Data               map[string]interface{} ``
	Name               *string                ``
	Stack              *string                ``
	AccessDeniedDetail map[string]interface{} ``
}

func (ClientError) Error added in v2.1.0 

func (err ClientError) Error() string

func (*ClientError) GetAccessDeniedDetail added in v2.1.0 

func (s *ClientError) GetAccessDeniedDetail() map[string]interface{}

func (*ClientError) GetCode added in v2.1.0 

func (s *ClientError) GetCode() *string

func (*ClientError) GetData added in v2.1.6 

func (s *ClientError) GetData() map[string]interface{}

func (*ClientError) GetDescription added in v2.1.0 

func (s *ClientError) GetDescription() *string

func (*ClientError) GetMessage added in v2.1.0 

func (s *ClientError) GetMessage() *string

func (*ClientError) GetName added in v2.1.0 

func (s *ClientError) GetName() *string

func (*ClientError) GetRequestId added in v2.1.0 

func (s *ClientError) GetRequestId() *string

func (*ClientError) GetRetryAfter added in v2.1.0 

func (s *ClientError) GetRetryAfter() *int64

func (*ClientError) GetStack added in v2.1.0 

func (s *ClientError) GetStack() *string

func (*ClientError) GetStatusCode added in v2.1.0 

func (s *ClientError) GetStatusCode() *int

type Config 

type Config = models.Config

type GlobalParameters 

type GlobalParameters = models.GlobalParameters

type OpenApiRequest 

type OpenApiRequest = models.OpenApiRequest

type Params 

type Params = models.Params

type SSEResponse added in v2.1.0 

type SSEResponse struct {
	Headers map[string]*string `json:"headers,omitempty" xml:"headers,omitempty" require:"true"`
	// HTTP Status Code
	StatusCode *int           `json:"statusCode,omitempty" xml:"statusCode,omitempty" require:"true"`
	Event      *dara.SSEEvent `json:"event,omitempty" xml:"event,omitempty" require:"true"`
}

func (*SSEResponse) GetEvent added in v2.1.0 

func (s *SSEResponse) GetEvent() *dara.SSEEvent

func (*SSEResponse) GetHeaders added in v2.1.0 

func (s *SSEResponse) GetHeaders() map[string]*string

func (*SSEResponse) GetStatusCode added in v2.1.0 

func (s *SSEResponse) GetStatusCode() *int

func (SSEResponse) GoString added in v2.1.0 

func (s SSEResponse) GoString() string

func (*SSEResponse) SetEvent added in v2.1.0 

func (s *SSEResponse) SetEvent(v *dara.SSEEvent) *SSEResponse

func (*SSEResponse) SetHeaders added in v2.1.0 

func (s *SSEResponse) SetHeaders(v map[string]*string) *SSEResponse

func (*SSEResponse) SetStatusCode added in v2.1.0 

func (s *SSEResponse) SetStatusCode(v int) *SSEResponse

func (SSEResponse) String added in v2.1.0 

func (s SSEResponse) String() string

func (*SSEResponse) Validate added in v2.1.0 

func (s *SSEResponse) Validate() error

type ServerError added in v2.1.0 

type ServerError struct {
	StatusCode         *int                   ``
	Code               *string                ``
	Message            *string                ``
	Description        *string                ``
	RequestId          *string                ``
	RetryAfter         *int64                 ``
	Data               map[string]interface{} ``
	AccessDeniedDetail map[string]interface{} ``
	Name               *string                ``
	Stack              *string                ``
}

func (ServerError) Error added in v2.1.0 

func (err ServerError) Error() string

func (*ServerError) GetAccessDeniedDetail added in v2.1.6 

func (s *ServerError) GetAccessDeniedDetail() map[string]interface{}

func (*ServerError) GetCode added in v2.1.0 

func (s *ServerError) GetCode() *string

func (*ServerError) GetData added in v2.1.6 

func (s *ServerError) GetData() map[string]interface{}

func (*ServerError) GetDescription added in v2.1.0 

func (s *ServerError) GetDescription() *string

func (*ServerError) GetMessage added in v2.1.0 

func (s *ServerError) GetMessage() *string

func (*ServerError) GetName added in v2.1.0 

func (s *ServerError) GetName() *string

func (*ServerError) GetRequestId added in v2.1.0 

func (s *ServerError) GetRequestId() *string

func (*ServerError) GetRetryAfter added in v2.1.0 

func (s *ServerError) GetRetryAfter() *int64

func (*ServerError) GetStack added in v2.1.0 

func (s *ServerError) GetStack() *string

func (*ServerError) GetStatusCode added in v2.1.0 

func (s *ServerError) GetStatusCode() *int

type ThrottlingError added in v2.1.0 

type ThrottlingError struct {
	StatusCode         *int                   ``
	Code               *string                ``
	Message            *string                ``
	Description        *string                ``
	RequestId          *string                ``
	Data               map[string]interface{} ``
	AccessDeniedDetail map[string]interface{} ``
	Name               *string                ``
	Stack              *string                ``
	RetryAfter         *int64                 ``
}

func (ThrottlingError) Error added in v2.1.0 

func (err ThrottlingError) Error() string

func (*ThrottlingError) GetAccessDeniedDetail added in v2.1.6 

func (s *ThrottlingError) GetAccessDeniedDetail() map[string]interface{}

func (*ThrottlingError) GetCode added in v2.1.0 

func (s *ThrottlingError) GetCode() *string

func (*ThrottlingError) GetData added in v2.1.6 

func (s *ThrottlingError) GetData() map[string]interface{}

func (*ThrottlingError) GetDescription added in v2.1.0 

func (s *ThrottlingError) GetDescription() *string

func (*ThrottlingError) GetMessage added in v2.1.0 

func (s *ThrottlingError) GetMessage() *string

func (*ThrottlingError) GetName added in v2.1.0 

func (s *ThrottlingError) GetName() *string

func (*ThrottlingError) GetRequestId added in v2.1.0 

func (s *ThrottlingError) GetRequestId() *string

func (*ThrottlingError) GetRetryAfter added in v2.1.0 

func (s *ThrottlingError) GetRetryAfter() *int64

func (*ThrottlingError) GetStack added in v2.1.0 

func (s *ThrottlingError) GetStack() *string

func (*ThrottlingError) GetStatusCode added in v2.1.0 

func (s *ThrottlingError) GetStatusCode() *int

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.