opensearch

Documentation

Index

• type Client
  • func NewClient() (client *Client, err error)
  • func NewClientWithAccessKey(regionId, accessKeyId, accessKeySecret string) (client *Client, err error)
  • func NewClientWithEcsRamRole(regionId string, roleName string) (client *Client, err error)
  • func NewClientWithOptions(regionId string, config *sdk.Config, credential auth.Credential) (client *Client, err error)
  • func NewClientWithRamRoleArn(regionId string, accessKeyId, accessKeySecret, roleArn, roleSessionName string) (client *Client, err error)
  • func NewClientWithRsaKeyPair(regionId string, publicKeyId, privateKey string, sessionExpiration int) (client *Client, err error)
  • func NewClientWithStsToken(regionId, stsAccessKeyId, stsAccessKeySecret, stsToken string) (client *Client, err error)
  • func (client *Client) ListApps(request *ListAppsRequest) (response *ListAppsResponse, err error)
  • func (client *Client) ListAppsWithCallback(request *ListAppsRequest, callback func(response *ListAppsResponse, err error)) <-chan int
  • func (client *Client) ListAppsWithChan(request *ListAppsRequest) (<-chan *ListAppsResponse, <-chan error)
• type ListAppsRequest
  • func CreateListAppsRequest() (request *ListAppsRequest)
• type ListAppsResponse
  • func CreateListAppsResponse() (response *ListAppsResponse)

Types

type Client

type Client struct {
	sdk.Client
}

Client is the sdk client struct, each func corresponds to an OpenAPI

func NewClient

func NewClient() (client *Client, err error)

NewClient creates a sdk client with environment variables

func NewClientWithAccessKey

func NewClientWithAccessKey(regionId, accessKeyId, accessKeySecret string) (client *Client, err error)

NewClientWithAccessKey is a shortcut to create sdk client with accesskey usage: https://help.aliyun.com/document_detail/66217.html

func NewClientWithEcsRamRole

func NewClientWithEcsRamRole(regionId string, roleName string) (client *Client, err error)

NewClientWithEcsRamRole is a shortcut to create sdk client with ecs ram role usage: https://help.aliyun.com/document_detail/66223.html

func NewClientWithOptions

func NewClientWithOptions(regionId string, config *sdk.Config, credential auth.Credential) (client *Client, err error)

NewClientWithOptions creates a sdk client with regionId/sdkConfig/credential this is the common api to create a sdk client

func NewClientWithRamRoleArn

func NewClientWithRamRoleArn(regionId string, accessKeyId, accessKeySecret, roleArn, roleSessionName string) (client *Client, err error)

NewClientWithRamRoleArn is a shortcut to create sdk client with ram roleArn usage: https://help.aliyun.com/document_detail/66222.html

func NewClientWithRsaKeyPair

func NewClientWithRsaKeyPair(regionId string, publicKeyId, privateKey string, sessionExpiration int) (client *Client, err error)

NewClientWithRsaKeyPair is a shortcut to create sdk client with rsa key pair attention: rsa key pair auth is only Japan regions available

func NewClientWithStsToken

func NewClientWithStsToken(regionId, stsAccessKeyId, stsAccessKeySecret, stsToken string) (client *Client, err error)

NewClientWithStsToken is a shortcut to create sdk client with sts token usage: https://help.aliyun.com/document_detail/66222.html

func (*Client) ListApps

func (client *Client) ListApps(request *ListAppsRequest) (response *ListAppsResponse, err error)

ListApps invokes the opensearch.ListApps API synchronously api document: https://help.aliyun.com/api/opensearch/listapps.html

func (*Client) ListAppsWithCallback

func (client *Client) ListAppsWithCallback(request *ListAppsRequest, callback func(response *ListAppsResponse, err error)) <-chan int

ListAppsWithCallback invokes the opensearch.ListApps API asynchronously api document: https://help.aliyun.com/api/opensearch/listapps.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

func (*Client) ListAppsWithChan

func (client *Client) ListAppsWithChan(request *ListAppsRequest) (<-chan *ListAppsResponse, <-chan error)

ListAppsWithChan invokes the opensearch.ListApps API asynchronously api document: https://help.aliyun.com/api/opensearch/listapps.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

type ListAppsRequest

type ListAppsRequest struct {
	*requests.RoaRequest
	Size  requests.Integer `position:"Query" name:"size"`
	Page  requests.Integer `position:"Query" name:"page"`
	Group requests.Boolean `position:"Query" name:"group"`
}

ListAppsRequest is the request struct for api ListApps

func CreateListAppsRequest

func CreateListAppsRequest() (request *ListAppsRequest)

CreateListAppsRequest creates a request to invoke ListApps API

type ListAppsResponse

type ListAppsResponse struct {
	*responses.BaseResponse
}

ListAppsResponse is the response struct for api ListApps

func CreateListAppsResponse

func CreateListAppsResponse() (response *ListAppsResponse)

CreateListAppsResponse creates a response to parse from ListApps response