btripopen

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) TakeAccessToken(request *TakeAccessTokenRequest) (response *TakeAccessTokenResponse, err error)
  • func (client *Client) TakeAccessTokenWithCallback(request *TakeAccessTokenRequest, ...) <-chan int
  • func (client *Client) TakeAccessTokenWithChan(request *TakeAccessTokenRequest) (<-chan *TakeAccessTokenResponse, <-chan error)
• type Data
• type TakeAccessTokenRequest
  • func CreateTakeAccessTokenRequest() (request *TakeAccessTokenRequest)
• type TakeAccessTokenResponse
  • func CreateTakeAccessTokenResponse() (response *TakeAccessTokenResponse)

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) TakeAccessToken

func (client *Client) TakeAccessToken(request *TakeAccessTokenRequest) (response *TakeAccessTokenResponse, err error)

TakeAccessToken invokes the btripopen.TakeAccessToken API synchronously

func (*Client) TakeAccessTokenWithCallback

func (client *Client) TakeAccessTokenWithCallback(request *TakeAccessTokenRequest, callback func(response *TakeAccessTokenResponse, err error)) <-chan int

TakeAccessTokenWithCallback invokes the btripopen.TakeAccessToken API asynchronously

func (*Client) TakeAccessTokenWithChan

func (client *Client) TakeAccessTokenWithChan(request *TakeAccessTokenRequest) (<-chan *TakeAccessTokenResponse, <-chan error)

TakeAccessTokenWithChan invokes the btripopen.TakeAccessToken API asynchronously

type Data

type Data struct {
	AccessToken string `json:"access_token" xml:"access_token"`
	Expire      int64  `json:"expire" xml:"expire"`
}

Data is a nested struct in btripopen response

type TakeAccessTokenRequest

type TakeAccessTokenRequest struct {
	*requests.RoaRequest
	AppKey    string `position:"Query" name:"app_key"`
	AppSecret string `position:"Query" name:"app_secret"`
}

TakeAccessTokenRequest is the request struct for api TakeAccessToken

func CreateTakeAccessTokenRequest

func CreateTakeAccessTokenRequest() (request *TakeAccessTokenRequest)

CreateTakeAccessTokenRequest creates a request to invoke TakeAccessToken API

type TakeAccessTokenResponse

type TakeAccessTokenResponse struct {
	*responses.BaseResponse
	RequestId string `json:"requestId" xml:"requestId"`
	Code      string `json:"code" xml:"code"`
	Message   string `json:"message" xml:"message"`
	Success   string `json:"success" xml:"success"`
	Data      Data   `json:"data" xml:"data"`
}

TakeAccessTokenResponse is the response struct for api TakeAccessToken

func CreateTakeAccessTokenResponse

func CreateTakeAccessTokenResponse() (response *TakeAccessTokenResponse)

CreateTakeAccessTokenResponse creates a response to parse from TakeAccessToken response