tingwu

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 NewClientWithProvider(regionId string, providers ...provider.Provider) (client *Client, err error)
  • func NewClientWithRamRoleArn(regionId string, accessKeyId, accessKeySecret, roleArn, roleSessionName string) (client *Client, err error)
  • func NewClientWithRamRoleArnAndPolicy(regionId 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) CreateTask(request *CreateTaskRequest) (response *CreateTaskResponse, err error)
  • func (client *Client) CreateTaskWithCallback(request *CreateTaskRequest, ...) <-chan int
  • func (client *Client) CreateTaskWithChan(request *CreateTaskRequest) (<-chan *CreateTaskResponse, <-chan error)
  • func (client *Client) GetTaskInfo(request *GetTaskInfoRequest) (response *GetTaskInfoResponse, err error)
  • func (client *Client) GetTaskInfoWithCallback(request *GetTaskInfoRequest, ...) <-chan int
  • func (client *Client) GetTaskInfoWithChan(request *GetTaskInfoRequest) (<-chan *GetTaskInfoResponse, <-chan error)
• type CreateTaskRequest
  • func CreateCreateTaskRequest() (request *CreateTaskRequest)
• type CreateTaskResponse
  • func CreateCreateTaskResponse() (response *CreateTaskResponse)
• type Data
• type GetTaskInfoRequest
  • func CreateGetTaskInfoRequest() (request *GetTaskInfoRequest)
• type GetTaskInfoResponse
  • func CreateGetTaskInfoResponse() (response *GetTaskInfoResponse)

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://github.com/aliyun/alibaba-cloud-sdk-go/blob/master/docs/2-Client-EN.md

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://github.com/aliyun/alibaba-cloud-sdk-go/blob/master/docs/2-Client-EN.md

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 NewClientWithProvider

func NewClientWithProvider(regionId string, providers ...provider.Provider) (client *Client, err error)

NewClientWithProvider creates a sdk client with providers usage: https://github.com/aliyun/alibaba-cloud-sdk-go/blob/master/docs/2-Client-EN.md

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://github.com/aliyun/alibaba-cloud-sdk-go/blob/master/docs/2-Client-EN.md

func NewClientWithRamRoleArnAndPolicy

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

NewClientWithRamRoleArn is a shortcut to create sdk client with ram roleArn and policy usage: https://github.com/aliyun/alibaba-cloud-sdk-go/blob/master/docs/2-Client-EN.md

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 usage: https://github.com/aliyun/alibaba-cloud-sdk-go/blob/master/docs/2-Client-EN.md

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://github.com/aliyun/alibaba-cloud-sdk-go/blob/master/docs/2-Client-EN.md

func (*Client) CreateTask

func (client *Client) CreateTask(request *CreateTaskRequest) (response *CreateTaskResponse, err error)

CreateTask invokes the tingwu.CreateTask API synchronously

func (*Client) CreateTaskWithCallback

func (client *Client) CreateTaskWithCallback(request *CreateTaskRequest, callback func(response *CreateTaskResponse, err error)) <-chan int

CreateTaskWithCallback invokes the tingwu.CreateTask API asynchronously

func (*Client) CreateTaskWithChan

func (client *Client) CreateTaskWithChan(request *CreateTaskRequest) (<-chan *CreateTaskResponse, <-chan error)

CreateTaskWithChan invokes the tingwu.CreateTask API asynchronously

func (*Client) GetTaskInfo

func (client *Client) GetTaskInfo(request *GetTaskInfoRequest) (response *GetTaskInfoResponse, err error)

GetTaskInfo invokes the tingwu.GetTaskInfo API synchronously

func (*Client) GetTaskInfoWithCallback

func (client *Client) GetTaskInfoWithCallback(request *GetTaskInfoRequest, callback func(response *GetTaskInfoResponse, err error)) <-chan int

GetTaskInfoWithCallback invokes the tingwu.GetTaskInfo API asynchronously

func (*Client) GetTaskInfoWithChan

func (client *Client) GetTaskInfoWithChan(request *GetTaskInfoRequest) (<-chan *GetTaskInfoResponse, <-chan error)

GetTaskInfoWithChan invokes the tingwu.GetTaskInfo API asynchronously

type CreateTaskRequest

type CreateTaskRequest struct {
	*requests.RoaRequest
	Type      string `position:"Query" name:"type"`
	Body      string `position:"Body" name:"body"`
	Operation string `position:"Query" name:"operation"`
}

CreateTaskRequest is the request struct for api CreateTask

func CreateCreateTaskRequest

func CreateCreateTaskRequest() (request *CreateTaskRequest)

CreateCreateTaskRequest creates a request to invoke CreateTask API

type CreateTaskResponse

type CreateTaskResponse struct {
	*responses.BaseResponse
	RequestId string `json:"RequestId" xml:"RequestId"`
	Code      string `json:"Code" xml:"Code"`
	Message   string `json:"Message" xml:"Message"`
	Data      Data   `json:"Data" xml:"Data"`
}

CreateTaskResponse is the response struct for api CreateTask

func CreateCreateTaskResponse

func CreateCreateTaskResponse() (response *CreateTaskResponse)

CreateCreateTaskResponse creates a response to parse from CreateTask response

type Data

type Data struct {
	TaskKey    string `json:"TaskKey" xml:"TaskKey"`
	TaskId     string `json:"TaskId" xml:"TaskId"`
	TaskStatus string `json:"TaskStatus" xml:"TaskStatus"`
}

Data is a nested struct in tingwu response

type GetTaskInfoRequest

type GetTaskInfoRequest struct {
	*requests.RoaRequest
	TaskId string `position:"Path" name:"TaskId"`
}

GetTaskInfoRequest is the request struct for api GetTaskInfo

func CreateGetTaskInfoRequest

func CreateGetTaskInfoRequest() (request *GetTaskInfoRequest)

CreateGetTaskInfoRequest creates a request to invoke GetTaskInfo API

type GetTaskInfoResponse

type GetTaskInfoResponse struct {
	*responses.BaseResponse
	RequestId string `json:"RequestId" xml:"RequestId"`
	Code      string `json:"Code" xml:"Code"`
	Message   string `json:"Message" xml:"Message"`
	Data      Data   `json:"Data" xml:"Data"`
}

GetTaskInfoResponse is the response struct for api GetTaskInfo

func CreateGetTaskInfoResponse

func CreateGetTaskInfoResponse() (response *GetTaskInfoResponse)

CreateGetTaskInfoResponse creates a response to parse from GetTaskInfo response