Documentation ¶
Index ¶
- Constants
- type ClearQueueRequest
- type ClearQueueResponse
- type ClearSubscriptionFilterTagsRequest
- type ClearSubscriptionFilterTagsResponse
- type Client
- func (c *Client) ClearQueue(request *ClearQueueRequest) (response *ClearQueueResponse, err error)
- func (c *Client) ClearSubscriptionFilterTags(request *ClearSubscriptionFilterTagsRequest) (response *ClearSubscriptionFilterTagsResponse, err error)
- func (c *Client) CreateQueue(request *CreateQueueRequest) (response *CreateQueueResponse, err error)
- func (c *Client) CreateSubscribe(request *CreateSubscribeRequest) (response *CreateSubscribeResponse, err error)
- func (c *Client) CreateTopic(request *CreateTopicRequest) (response *CreateTopicResponse, err error)
- func (c *Client) DeleteQueue(request *DeleteQueueRequest) (response *DeleteQueueResponse, err error)
- func (c *Client) DeleteSubscribe(request *DeleteSubscribeRequest) (response *DeleteSubscribeResponse, err error)
- func (c *Client) DeleteTopic(request *DeleteTopicRequest) (response *DeleteTopicResponse, err error)
- func (c *Client) DescribeDeadLetterSourceQueues(request *DescribeDeadLetterSourceQueuesRequest) (response *DescribeDeadLetterSourceQueuesResponse, err error)
- func (c *Client) DescribeQueueDetail(request *DescribeQueueDetailRequest) (response *DescribeQueueDetailResponse, err error)
- func (c *Client) DescribeSubscriptionDetail(request *DescribeSubscriptionDetailRequest) (response *DescribeSubscriptionDetailResponse, err error)
- func (c *Client) DescribeTopicDetail(request *DescribeTopicDetailRequest) (response *DescribeTopicDetailResponse, err error)
- func (c *Client) ModifyQueueAttribute(request *ModifyQueueAttributeRequest) (response *ModifyQueueAttributeResponse, err error)
- func (c *Client) ModifySubscriptionAttribute(request *ModifySubscriptionAttributeRequest) (response *ModifySubscriptionAttributeResponse, err error)
- func (c *Client) ModifyTopicAttribute(request *ModifyTopicAttributeRequest) (response *ModifyTopicAttributeResponse, err error)
- func (c *Client) RewindQueue(request *RewindQueueRequest) (response *RewindQueueResponse, err error)
- func (c *Client) UnbindDeadLetter(request *UnbindDeadLetterRequest) (response *UnbindDeadLetterResponse, err error)
- type CreateQueueRequest
- type CreateQueueResponse
- type CreateSubscribeRequest
- type CreateSubscribeResponse
- type CreateTopicRequest
- type CreateTopicResponse
- type DeadLetterPolicy
- type DeadLetterSource
- type DeleteQueueRequest
- type DeleteQueueResponse
- type DeleteSubscribeRequest
- type DeleteSubscribeResponse
- type DeleteTopicRequest
- type DeleteTopicResponse
- type DescribeDeadLetterSourceQueuesRequest
- type DescribeDeadLetterSourceQueuesResponse
- type DescribeQueueDetailRequest
- type DescribeQueueDetailResponse
- type DescribeSubscriptionDetailRequest
- type DescribeSubscriptionDetailResponse
- type DescribeTopicDetailRequest
- type DescribeTopicDetailResponse
- type Filter
- type ModifyQueueAttributeRequest
- type ModifyQueueAttributeResponse
- type ModifySubscriptionAttributeRequest
- type ModifySubscriptionAttributeResponse
- type ModifyTopicAttributeRequest
- type ModifyTopicAttributeResponse
- type QueueSet
- type RewindQueueRequest
- type RewindQueueResponse
- type Subscription
- type Tag
- type TopicSet
- type TransactionPolicy
- type UnbindDeadLetterRequest
- type UnbindDeadLetterResponse
Constants ¶
const ( // Operation failed. FAILEDOPERATION = "FailedOperation" // The operation is in progress. Please try again later. FAILEDOPERATION_TRYLATER = "FailedOperation.TryLater" // Invalid parameter. INVALIDPARAMETER = "InvalidParameter" // The task ID does not exist. INVALIDPARAMETERVALUE_NOTASKID = "InvalidParameterValue.NoTaskId" // The quota limit is exceeded. LIMITEXCEEDED = "LimitExceeded" // The resource is in use. RESOURCEINUSE = "ResourceInUse" // The resource does not exist. RESOURCENOTFOUND = "ResourceNotFound" // The resource is unavailable. RESOURCEUNAVAILABLE = "ResourceUnavailable" // The resources have been sold out. RESOURCESSOLDOUT = "ResourcesSoldOut" // Unauthorized operation. UNAUTHORIZEDOPERATION = "UnauthorizedOperation" )
const APIVersion = "2019-03-04"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ClearQueueRequest ¶
type ClearQueueRequest struct { *tchttp.BaseRequest // Queue name, which is unique under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`). QueueName *string `json:"QueueName,omitempty" name:"QueueName"` }
func NewClearQueueRequest ¶
func NewClearQueueRequest() (request *ClearQueueRequest)
func (*ClearQueueRequest) FromJsonString ¶
func (r *ClearQueueRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ClearQueueRequest) ToJsonString ¶
func (r *ClearQueueRequest) ToJsonString() string
type ClearQueueResponse ¶
type ClearQueueResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewClearQueueResponse ¶
func NewClearQueueResponse() (response *ClearQueueResponse)
func (*ClearQueueResponse) FromJsonString ¶
func (r *ClearQueueResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ClearQueueResponse) ToJsonString ¶
func (r *ClearQueueResponse) ToJsonString() string
type ClearSubscriptionFilterTagsRequest ¶
type ClearSubscriptionFilterTagsRequest struct { *tchttp.BaseRequest // Topic name, which is unique under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`). TopicName *string `json:"TopicName,omitempty" name:"TopicName"` // Subscription name, which is unique in the same topic under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`). SubscriptionName *string `json:"SubscriptionName,omitempty" name:"SubscriptionName"` }
func NewClearSubscriptionFilterTagsRequest ¶
func NewClearSubscriptionFilterTagsRequest() (request *ClearSubscriptionFilterTagsRequest)
func (*ClearSubscriptionFilterTagsRequest) FromJsonString ¶
func (r *ClearSubscriptionFilterTagsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ClearSubscriptionFilterTagsRequest) ToJsonString ¶
func (r *ClearSubscriptionFilterTagsRequest) ToJsonString() string
type ClearSubscriptionFilterTagsResponse ¶
type ClearSubscriptionFilterTagsResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewClearSubscriptionFilterTagsResponse ¶
func NewClearSubscriptionFilterTagsResponse() (response *ClearSubscriptionFilterTagsResponse)
func (*ClearSubscriptionFilterTagsResponse) FromJsonString ¶
func (r *ClearSubscriptionFilterTagsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ClearSubscriptionFilterTagsResponse) ToJsonString ¶
func (r *ClearSubscriptionFilterTagsResponse) ToJsonString() string
type Client ¶
func NewClient ¶
func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) ClearQueue ¶
func (c *Client) ClearQueue(request *ClearQueueRequest) (response *ClearQueueResponse, err error)
ClearQueue This API is used to clear all messages in a queue.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TRYLATER = "FailedOperation.TryLater" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_NOTASKID = "InvalidParameterValue.NoTaskId" LIMITEXCEEDED = "LimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) ClearSubscriptionFilterTags ¶
func (c *Client) ClearSubscriptionFilterTags(request *ClearSubscriptionFilterTagsRequest) (response *ClearSubscriptionFilterTagsResponse, err error)
ClearSubscriptionFilterTags This API is used to clear the message tags of a subscriber.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TRYLATER = "FailedOperation.TryLater" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_NOTASKID = "InvalidParameterValue.NoTaskId" LIMITEXCEEDED = "LimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) CreateQueue ¶
func (c *Client) CreateQueue(request *CreateQueueRequest) (response *CreateQueueResponse, err error)
CreateQueue This API is used to create a queue.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TRYLATER = "FailedOperation.TryLater" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED = "LimitExceeded" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) CreateSubscribe ¶
func (c *Client) CreateSubscribe(request *CreateSubscribeRequest) (response *CreateSubscribeResponse, err error)
CreateSubscribe This API is used to create a subscription.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TRYLATER = "FailedOperation.TryLater" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_NOTASKID = "InvalidParameterValue.NoTaskId" LIMITEXCEEDED = "LimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) CreateTopic ¶
func (c *Client) CreateTopic(request *CreateTopicRequest) (response *CreateTopicResponse, err error)
CreateTopic This API is used to create a topic.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TRYLATER = "FailedOperation.TryLater" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED = "LimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DeleteQueue ¶
func (c *Client) DeleteQueue(request *DeleteQueueRequest) (response *DeleteQueueResponse, err error)
DeleteQueue This API is used to delete a queue.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INVALIDPARAMETER = "InvalidParameter" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DeleteSubscribe ¶
func (c *Client) DeleteSubscribe(request *DeleteSubscribeRequest) (response *DeleteSubscribeResponse, err error)
DeleteSubscribe This API is used to delete a subscription.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TRYLATER = "FailedOperation.TryLater" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED = "LimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DeleteTopic ¶
func (c *Client) DeleteTopic(request *DeleteTopicRequest) (response *DeleteTopicResponse, err error)
DeleteTopic This API is used to delete a topic.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TRYLATER = "FailedOperation.TryLater" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED = "LimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeDeadLetterSourceQueues ¶
func (c *Client) DescribeDeadLetterSourceQueues(request *DescribeDeadLetterSourceQueuesRequest) (response *DescribeDeadLetterSourceQueuesResponse, err error)
DescribeDeadLetterSourceQueues This API is used to enumerate the source queues of a dead letter queue.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TRYLATER = "FailedOperation.TryLater" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED = "LimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeQueueDetail ¶
func (c *Client) DescribeQueueDetail(request *DescribeQueueDetailRequest) (response *DescribeQueueDetailResponse, err error)
DescribeQueueDetail This API is used to enumerate queues.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TRYLATER = "FailedOperation.TryLater" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED = "LimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeSubscriptionDetail ¶
func (c *Client) DescribeSubscriptionDetail(request *DescribeSubscriptionDetailRequest) (response *DescribeSubscriptionDetailResponse, err error)
DescribeSubscriptionDetail This API is used to query subscription details.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TRYLATER = "FailedOperation.TryLater" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_NOTASKID = "InvalidParameterValue.NoTaskId" LIMITEXCEEDED = "LimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeTopicDetail ¶
func (c *Client) DescribeTopicDetail(request *DescribeTopicDetailRequest) (response *DescribeTopicDetailResponse, err error)
DescribeTopicDetail This API is used to query topic details.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TRYLATER = "FailedOperation.TryLater" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_NOTASKID = "InvalidParameterValue.NoTaskId" LIMITEXCEEDED = "LimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) ModifyQueueAttribute ¶
func (c *Client) ModifyQueueAttribute(request *ModifyQueueAttributeRequest) (response *ModifyQueueAttributeResponse, err error)
ModifyQueueAttribute This API is used to modify queue attributes.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TRYLATER = "FailedOperation.TryLater" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_NOTASKID = "InvalidParameterValue.NoTaskId" LIMITEXCEEDED = "LimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) ModifySubscriptionAttribute ¶
func (c *Client) ModifySubscriptionAttribute(request *ModifySubscriptionAttributeRequest) (response *ModifySubscriptionAttributeResponse, err error)
ModifySubscriptionAttribute This API is used to modify subscription attributes.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TRYLATER = "FailedOperation.TryLater" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_NOTASKID = "InvalidParameterValue.NoTaskId" LIMITEXCEEDED = "LimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) ModifyTopicAttribute ¶
func (c *Client) ModifyTopicAttribute(request *ModifyTopicAttributeRequest) (response *ModifyTopicAttributeResponse, err error)
ModifyTopicAttribute This API is used to modify topic attributes.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TRYLATER = "FailedOperation.TryLater" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED = "LimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) RewindQueue ¶
func (c *Client) RewindQueue(request *RewindQueueRequest) (response *RewindQueueResponse, err error)
RewindQueue This API is used to rewind a queue.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TRYLATER = "FailedOperation.TryLater" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED = "LimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) UnbindDeadLetter ¶
func (c *Client) UnbindDeadLetter(request *UnbindDeadLetterRequest) (response *UnbindDeadLetterResponse, err error)
UnbindDeadLetter This API is used to unbind a dead letter queue.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TRYLATER = "FailedOperation.TryLater" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_NOTASKID = "InvalidParameterValue.NoTaskId" LIMITEXCEEDED = "LimitExceeded" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
type CreateQueueRequest ¶
type CreateQueueRequest struct { *tchttp.BaseRequest // Queue name, which is unique under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`). QueueName *string `json:"QueueName,omitempty" name:"QueueName"` // Maximum number of heaped messages. The value range is 1,000,000–10,000,000 during the beta test and can be 1,000,000–1,000,000,000 after the product is officially released. The default value is 10,000,000 during the beta test and will be 100,000,000 after the product is officially released. MaxMsgHeapNum *uint64 `json:"MaxMsgHeapNum,omitempty" name:"MaxMsgHeapNum"` // Long polling wait time for message reception. Value range: 0–30 seconds. Default value: 0. PollingWaitSeconds *uint64 `json:"PollingWaitSeconds,omitempty" name:"PollingWaitSeconds"` // Message visibility timeout period. Value range: 1–43200 seconds (i.e., 12 hours). Default value: 30. VisibilityTimeout *uint64 `json:"VisibilityTimeout,omitempty" name:"VisibilityTimeout"` // Maximum message length. Value range: 1024–65536 bytes (i.e., 1–64 KB). Default value: 65536. MaxMsgSize *uint64 `json:"MaxMsgSize,omitempty" name:"MaxMsgSize"` // Message retention period. Value range: 60–1296000 seconds (i.e., 1 minute–15 days). Default value: 345600 (i.e., 4 days). MsgRetentionSeconds *uint64 `json:"MsgRetentionSeconds,omitempty" name:"MsgRetentionSeconds"` // Whether to enable the message rewinding feature for a queue. Value range: 0–msgRetentionSeconds, where 0 means not to enable this feature, while `msgRetentionSeconds` indicates that the maximum rewindable period is the message retention period of the queue. RewindSeconds *uint64 `json:"RewindSeconds,omitempty" name:"RewindSeconds"` // 1: transaction queue, 0: general queue Transaction *uint64 `json:"Transaction,omitempty" name:"Transaction"` // First lookback interval FirstQueryInterval *uint64 `json:"FirstQueryInterval,omitempty" name:"FirstQueryInterval"` // Maximum number of lookbacks MaxQueryCount *uint64 `json:"MaxQueryCount,omitempty" name:"MaxQueryCount"` // Dead letter queue name DeadLetterQueueName *string `json:"DeadLetterQueueName,omitempty" name:"DeadLetterQueueName"` // Dead letter policy. 0: message has been consumed multiple times but not deleted, 1: `Time-To-Live` has elapsed Policy *uint64 `json:"Policy,omitempty" name:"Policy"` // Maximum receipt times. Value range: 1–1000 MaxReceiveCount *uint64 `json:"MaxReceiveCount,omitempty" name:"MaxReceiveCount"` // Maximum period in seconds before an unconsumed message expires, which is required if `policy` is 1. Value range: 300–43200. This value should be smaller than `msgRetentionSeconds` (maximum message retention period) MaxTimeToLive *uint64 `json:"MaxTimeToLive,omitempty" name:"MaxTimeToLive"` // Whether to enable message trace. true: yes, false: no. If this field is not set, the feature will not be enabled Trace *bool `json:"Trace,omitempty" name:"Trace"` }
func NewCreateQueueRequest ¶
func NewCreateQueueRequest() (request *CreateQueueRequest)
func (*CreateQueueRequest) FromJsonString ¶
func (r *CreateQueueRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateQueueRequest) ToJsonString ¶
func (r *CreateQueueRequest) ToJsonString() string
type CreateQueueResponse ¶
type CreateQueueResponse struct { *tchttp.BaseResponse Response *struct { // `queueId` of a successfully created queue QueueId *string `json:"QueueId,omitempty" name:"QueueId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateQueueResponse ¶
func NewCreateQueueResponse() (response *CreateQueueResponse)
func (*CreateQueueResponse) FromJsonString ¶
func (r *CreateQueueResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateQueueResponse) ToJsonString ¶
func (r *CreateQueueResponse) ToJsonString() string
type CreateSubscribeRequest ¶
type CreateSubscribeRequest struct { *tchttp.BaseRequest // Topic name, which is unique under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`). TopicName *string `json:"TopicName,omitempty" name:"TopicName"` // Subscription name, which is unique in the same topic under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`). SubscriptionName *string `json:"SubscriptionName,omitempty" name:"SubscriptionName"` // Subscription protocol. Currently, two protocols are supported: http and queue. To use the `http` protocol, you need to build your own web server to receive messages. With the `queue` protocol, messages are automatically pushed to a CMQ queue and you can pull them concurrently. Protocol *string `json:"Protocol,omitempty" name:"Protocol"` // `Endpoint` for notification receipt, which is distinguished by `Protocol`. For `http`, `Endpoint` must begin with `http://` and `host` can be a domain name or IP. For `Queue`, enter `QueueName`. Please note that currently the push service cannot push messages to a VPC; therefore, if a VPC domain name or address is entered for `Endpoint`, pushed messages will not be received. Currently, messages can be pushed only to the public network and basic network. Endpoint *string `json:"Endpoint,omitempty" name:"Endpoint"` // CMQ push server retry policy in case an error occurs while pushing a message to `Endpoint`. Valid values: 1. BACKOFF_RETRY: backoff retry, which is to retry at a fixed interval, discard the message after a certain number of retries, and continue to push the next message; 2. EXPONENTIAL_DECAY_RETRY: exponential decay retry, which is to retry at an exponentially increasing interval, such as 1s, 2s, 4s, 8s, and so on. As a message can be retained in a topic for one day, failed messages will be discarded at most after one day of retry. Default value: EXPONENTIAL_DECAY_RETRY. NotifyStrategy *string `json:"NotifyStrategy,omitempty" name:"NotifyStrategy"` // Message body tag (used for message filtering). The number of tags cannot exceed 5, and each tag can contain up to 16 characters. It is used in conjunction with the `MsgTag` parameter of `(Batch)PublishMessage`. Rules: 1. If `FilterTag` is not set, no matter whether `MsgTag` is set, the subscription will receive all messages published to the topic; 2. If the `FilterTag` array has a value, only when at least one of the values in the array also exists in the `MsgTag` array (i.e., `FilterTag` and `MsgTag` have an intersection) can the subscription receive messages published to the topic; 3. If the `FilterTag` array has a value, but `MsgTag` is not set, then no message published to the topic will be received, which can be considered as a special case of rule 2 as `FilterTag` and `MsgTag` do not intersect in this case. The overall design idea of rules is based on the intention of the subscriber. FilterTag []*string `json:"FilterTag,omitempty" name:"FilterTag"` // The number of `BindingKey` cannot exceed 5, and the length of each `BindingKey` cannot exceed 64 bytes. This field indicates the filtering policy for subscribing to and receiving messages. Each `BindingKey` can contain up to 15 `.`, i.e., up to 16 phrases. BindingKey []*string `json:"BindingKey,omitempty" name:"BindingKey"` // Push content format. Valid values: 1. JSON, 2. SIMPLIFIED, i.e., the raw format. If `Protocol` is `queue`, this value must be `SIMPLIFIED`. If `Protocol` is `http`, both options are acceptable, and the default value is `JSON`. NotifyContentFormat *string `json:"NotifyContentFormat,omitempty" name:"NotifyContentFormat"` }
func NewCreateSubscribeRequest ¶
func NewCreateSubscribeRequest() (request *CreateSubscribeRequest)
func (*CreateSubscribeRequest) FromJsonString ¶
func (r *CreateSubscribeRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateSubscribeRequest) ToJsonString ¶
func (r *CreateSubscribeRequest) ToJsonString() string
type CreateSubscribeResponse ¶
type CreateSubscribeResponse struct { *tchttp.BaseResponse Response *struct { // SubscriptionId SubscriptionId *string `json:"SubscriptionId,omitempty" name:"SubscriptionId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateSubscribeResponse ¶
func NewCreateSubscribeResponse() (response *CreateSubscribeResponse)
func (*CreateSubscribeResponse) FromJsonString ¶
func (r *CreateSubscribeResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateSubscribeResponse) ToJsonString ¶
func (r *CreateSubscribeResponse) ToJsonString() string
type CreateTopicRequest ¶
type CreateTopicRequest struct { *tchttp.BaseRequest // Topic name, which is unique under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`). TopicName *string `json:"TopicName,omitempty" name:"TopicName"` // Maximum message length. Value range: 1024–65536 bytes (i.e., 1–64 KB). Default value: 65536. MaxMsgSize *uint64 `json:"MaxMsgSize,omitempty" name:"MaxMsgSize"` // Message match policy for a specified topic. FilterType *uint64 `json:"FilterType,omitempty" name:"FilterType"` // Message retention period. Value range: 60–86400 seconds (i.e., 1 minute–1 day). Default value: 86400. MsgRetentionSeconds *uint64 `json:"MsgRetentionSeconds,omitempty" name:"MsgRetentionSeconds"` // Whether to enable message trace. true: yes, false: no. If this field is left empty, the feature will not be enabled. Trace *bool `json:"Trace,omitempty" name:"Trace"` }
func NewCreateTopicRequest ¶
func NewCreateTopicRequest() (request *CreateTopicRequest)
func (*CreateTopicRequest) FromJsonString ¶
func (r *CreateTopicRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateTopicRequest) ToJsonString ¶
func (r *CreateTopicRequest) ToJsonString() string
type CreateTopicResponse ¶
type CreateTopicResponse struct { *tchttp.BaseResponse Response *struct { // TopicName TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateTopicResponse ¶
func NewCreateTopicResponse() (response *CreateTopicResponse)
func (*CreateTopicResponse) FromJsonString ¶
func (r *CreateTopicResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateTopicResponse) ToJsonString ¶
func (r *CreateTopicResponse) ToJsonString() string
type DeadLetterPolicy ¶
type DeadLetterPolicy struct { // DeadLetterQueueName // Note: this field may return null, indicating that no valid values can be obtained. DeadLetterQueueName *string `json:"DeadLetterQueueName,omitempty" name:"DeadLetterQueueName"` // DeadLetterQueue // Note: this field may return null, indicating that no valid values can be obtained. DeadLetterQueue *string `json:"DeadLetterQueue,omitempty" name:"DeadLetterQueue"` // Policy // Note: this field may return null, indicating that no valid values can be obtained. Policy *uint64 `json:"Policy,omitempty" name:"Policy"` // MaxTimeToLive // Note: this field may return null, indicating that no valid values can be obtained. MaxTimeToLive *uint64 `json:"MaxTimeToLive,omitempty" name:"MaxTimeToLive"` // MaxReceiveCount // Note: this field may return null, indicating that no valid values can be obtained. MaxReceiveCount *uint64 `json:"MaxReceiveCount,omitempty" name:"MaxReceiveCount"` }
type DeadLetterSource ¶
type DeadLetterSource struct { // QueueId // Note: this field may return null, indicating that no valid values can be obtained. QueueId *string `json:"QueueId,omitempty" name:"QueueId"` // QueueName // Note: this field may return null, indicating that no valid values can be obtained. QueueName *string `json:"QueueName,omitempty" name:"QueueName"` }
type DeleteQueueRequest ¶
type DeleteQueueRequest struct { *tchttp.BaseRequest // Queue name, which is unique under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`). QueueName *string `json:"QueueName,omitempty" name:"QueueName"` }
func NewDeleteQueueRequest ¶
func NewDeleteQueueRequest() (request *DeleteQueueRequest)
func (*DeleteQueueRequest) FromJsonString ¶
func (r *DeleteQueueRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteQueueRequest) ToJsonString ¶
func (r *DeleteQueueRequest) ToJsonString() string
type DeleteQueueResponse ¶
type DeleteQueueResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteQueueResponse ¶
func NewDeleteQueueResponse() (response *DeleteQueueResponse)
func (*DeleteQueueResponse) FromJsonString ¶
func (r *DeleteQueueResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteQueueResponse) ToJsonString ¶
func (r *DeleteQueueResponse) ToJsonString() string
type DeleteSubscribeRequest ¶
type DeleteSubscribeRequest struct { *tchttp.BaseRequest // Topic name, which is unique under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`). TopicName *string `json:"TopicName,omitempty" name:"TopicName"` // Subscription name, which is unique in the same topic under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`). SubscriptionName *string `json:"SubscriptionName,omitempty" name:"SubscriptionName"` }
func NewDeleteSubscribeRequest ¶
func NewDeleteSubscribeRequest() (request *DeleteSubscribeRequest)
func (*DeleteSubscribeRequest) FromJsonString ¶
func (r *DeleteSubscribeRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteSubscribeRequest) ToJsonString ¶
func (r *DeleteSubscribeRequest) ToJsonString() string
type DeleteSubscribeResponse ¶
type DeleteSubscribeResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteSubscribeResponse ¶
func NewDeleteSubscribeResponse() (response *DeleteSubscribeResponse)
func (*DeleteSubscribeResponse) FromJsonString ¶
func (r *DeleteSubscribeResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteSubscribeResponse) ToJsonString ¶
func (r *DeleteSubscribeResponse) ToJsonString() string
type DeleteTopicRequest ¶
type DeleteTopicRequest struct { *tchttp.BaseRequest // Topic name, which is unique under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`). TopicName *string `json:"TopicName,omitempty" name:"TopicName"` }
func NewDeleteTopicRequest ¶
func NewDeleteTopicRequest() (request *DeleteTopicRequest)
func (*DeleteTopicRequest) FromJsonString ¶
func (r *DeleteTopicRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteTopicRequest) ToJsonString ¶
func (r *DeleteTopicRequest) ToJsonString() string
type DeleteTopicResponse ¶
type DeleteTopicResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteTopicResponse ¶
func NewDeleteTopicResponse() (response *DeleteTopicResponse)
func (*DeleteTopicResponse) FromJsonString ¶
func (r *DeleteTopicResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteTopicResponse) ToJsonString ¶
func (r *DeleteTopicResponse) ToJsonString() string
type DescribeDeadLetterSourceQueuesRequest ¶
type DescribeDeadLetterSourceQueuesRequest struct { *tchttp.BaseRequest // Dead letter queue name DeadLetterQueueName *string `json:"DeadLetterQueueName,omitempty" name:"DeadLetterQueueName"` // Starting position of topic list to be returned on the current page in case of paginated return. If a value is entered, `limit` is required. If this parameter is left empty, 0 will be used by default. Limit *uint64 `json:"Limit,omitempty" name:"Limit"` // Number of topics to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50. Offset *uint64 `json:"Offset,omitempty" name:"Offset"` // Filters source queue name of dead letter queue. Currently, only filtering by `SourceQueueName` is supported Filters []*Filter `json:"Filters,omitempty" name:"Filters"` }
func NewDescribeDeadLetterSourceQueuesRequest ¶
func NewDescribeDeadLetterSourceQueuesRequest() (request *DescribeDeadLetterSourceQueuesRequest)
func (*DescribeDeadLetterSourceQueuesRequest) FromJsonString ¶
func (r *DescribeDeadLetterSourceQueuesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeDeadLetterSourceQueuesRequest) ToJsonString ¶
func (r *DescribeDeadLetterSourceQueuesRequest) ToJsonString() string
type DescribeDeadLetterSourceQueuesResponse ¶
type DescribeDeadLetterSourceQueuesResponse struct { *tchttp.BaseResponse Response *struct { // Number of eligible queues TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"` // Source queues of dead letter queue QueueSet []*DeadLetterSource `json:"QueueSet,omitempty" name:"QueueSet"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeDeadLetterSourceQueuesResponse ¶
func NewDescribeDeadLetterSourceQueuesResponse() (response *DescribeDeadLetterSourceQueuesResponse)
func (*DescribeDeadLetterSourceQueuesResponse) FromJsonString ¶
func (r *DescribeDeadLetterSourceQueuesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeDeadLetterSourceQueuesResponse) ToJsonString ¶
func (r *DescribeDeadLetterSourceQueuesResponse) ToJsonString() string
type DescribeQueueDetailRequest ¶
type DescribeQueueDetailRequest struct { *tchttp.BaseRequest // Starting position of queue list to be returned on the current page in case of paginated return. If a value is entered, `limit` is required. If this parameter is left empty, 0 will be used by default Offset *uint64 `json:"Offset,omitempty" name:"Offset"` // Number of queues to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50. Limit *uint64 `json:"Limit,omitempty" name:"Limit"` // Filter parameter. Currently, filtering by `QueueName` is supported, and only one keyword is allowed Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Tag search TagKey *string `json:"TagKey,omitempty" name:"TagKey"` // Exact match by `QueueName` QueueName *string `json:"QueueName,omitempty" name:"QueueName"` }
func NewDescribeQueueDetailRequest ¶
func NewDescribeQueueDetailRequest() (request *DescribeQueueDetailRequest)
func (*DescribeQueueDetailRequest) FromJsonString ¶
func (r *DescribeQueueDetailRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeQueueDetailRequest) ToJsonString ¶
func (r *DescribeQueueDetailRequest) ToJsonString() string
type DescribeQueueDetailResponse ¶
type DescribeQueueDetailResponse struct { *tchttp.BaseResponse Response *struct { // Total number of queues TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"` // Queue list QueueSet []*QueueSet `json:"QueueSet,omitempty" name:"QueueSet"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeQueueDetailResponse ¶
func NewDescribeQueueDetailResponse() (response *DescribeQueueDetailResponse)
func (*DescribeQueueDetailResponse) FromJsonString ¶
func (r *DescribeQueueDetailResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeQueueDetailResponse) ToJsonString ¶
func (r *DescribeQueueDetailResponse) ToJsonString() string
type DescribeSubscriptionDetailRequest ¶
type DescribeSubscriptionDetailRequest struct { *tchttp.BaseRequest // Topic name, which is unique under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`). TopicName *string `json:"TopicName,omitempty" name:"TopicName"` // Starting position of topic list to be returned on the current page in case of paginated return. If a value is entered, `limit` is required. If this parameter is left empty, 0 will be used by default Offset *uint64 `json:"Offset,omitempty" name:"Offset"` // Number of topics to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50. Limit *uint64 `json:"Limit,omitempty" name:"Limit"` // Filter parameter. Currently, only filtering by `SubscriptionName` is supported, and only one keyword is allowed. Filters []*Filter `json:"Filters,omitempty" name:"Filters"` }
func NewDescribeSubscriptionDetailRequest ¶
func NewDescribeSubscriptionDetailRequest() (request *DescribeSubscriptionDetailRequest)
func (*DescribeSubscriptionDetailRequest) FromJsonString ¶
func (r *DescribeSubscriptionDetailRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeSubscriptionDetailRequest) ToJsonString ¶
func (r *DescribeSubscriptionDetailRequest) ToJsonString() string
type DescribeSubscriptionDetailResponse ¶
type DescribeSubscriptionDetailResponse struct { *tchttp.BaseResponse Response *struct { // Total number TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"` // Subscription attribute set // Note: this field may return null, indicating that no valid values can be obtained. SubscriptionSet []*Subscription `json:"SubscriptionSet,omitempty" name:"SubscriptionSet"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeSubscriptionDetailResponse ¶
func NewDescribeSubscriptionDetailResponse() (response *DescribeSubscriptionDetailResponse)
func (*DescribeSubscriptionDetailResponse) FromJsonString ¶
func (r *DescribeSubscriptionDetailResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeSubscriptionDetailResponse) ToJsonString ¶
func (r *DescribeSubscriptionDetailResponse) ToJsonString() string
type DescribeTopicDetailRequest ¶
type DescribeTopicDetailRequest struct { *tchttp.BaseRequest // Starting position of queue list to be returned on the current page in case of paginated return. If a value is entered, `limit` is required. If this parameter is left empty, 0 will be used by default. Offset *uint64 `json:"Offset,omitempty" name:"Offset"` // Number of queues to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50. Limit *uint64 `json:"Limit,omitempty" name:"Limit"` // Currently, only filtering by `TopicName` is supported, and only one filter value can be entered Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Tag match TagKey *string `json:"TagKey,omitempty" name:"TagKey"` // Exact match by `TopicName` TopicName *string `json:"TopicName,omitempty" name:"TopicName"` }
func NewDescribeTopicDetailRequest ¶
func NewDescribeTopicDetailRequest() (request *DescribeTopicDetailRequest)
func (*DescribeTopicDetailRequest) FromJsonString ¶
func (r *DescribeTopicDetailRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTopicDetailRequest) ToJsonString ¶
func (r *DescribeTopicDetailRequest) ToJsonString() string
type DescribeTopicDetailResponse ¶
type DescribeTopicDetailResponse struct { *tchttp.BaseResponse Response *struct { // TotalCount TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"` // TopicSet TopicSet []*TopicSet `json:"TopicSet,omitempty" name:"TopicSet"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeTopicDetailResponse ¶
func NewDescribeTopicDetailResponse() (response *DescribeTopicDetailResponse)
func (*DescribeTopicDetailResponse) FromJsonString ¶
func (r *DescribeTopicDetailResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeTopicDetailResponse) ToJsonString ¶
func (r *DescribeTopicDetailResponse) ToJsonString() string
type ModifyQueueAttributeRequest ¶
type ModifyQueueAttributeRequest struct { *tchttp.BaseRequest // Queue name, which is unique under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`). QueueName *string `json:"QueueName,omitempty" name:"QueueName"` // Maximum number of heaped messages. The value range is 1,000,000–10,000,000 during the beta test and can be 1,000,000–1,000,000,000 after the product is officially released. The default value is 10,000,000 during the beta test and will be 100,000,000 after the product is officially released. MaxMsgHeapNum *uint64 `json:"MaxMsgHeapNum,omitempty" name:"MaxMsgHeapNum"` // Long polling wait time for message reception. Value range: 0–30 seconds. Default value: 0. PollingWaitSeconds *uint64 `json:"PollingWaitSeconds,omitempty" name:"PollingWaitSeconds"` // Message visibility timeout period. Value range: 1–43200 seconds (i.e., 12 hours). Default value: 30. VisibilityTimeout *uint64 `json:"VisibilityTimeout,omitempty" name:"VisibilityTimeout"` // Maximum message length. Value range: 1024–65536 bytes (i.e., 1–64 KB). Default value: 65536. MaxMsgSize *uint64 `json:"MaxMsgSize,omitempty" name:"MaxMsgSize"` // Message retention period. Value range: 60–1296000 seconds (i.e., 1 minute–15 days). Default value: 345600 (i.e., 4 days). MsgRetentionSeconds *uint64 `json:"MsgRetentionSeconds,omitempty" name:"MsgRetentionSeconds"` // Maximum message rewindable period. Value range: 0–msgRetentionSeconds (maximum message retention period of a queue). 0 means not to enable message rewinding. RewindSeconds *uint64 `json:"RewindSeconds,omitempty" name:"RewindSeconds"` // First query time FirstQueryInterval *uint64 `json:"FirstQueryInterval,omitempty" name:"FirstQueryInterval"` // Maximum number of queries MaxQueryCount *uint64 `json:"MaxQueryCount,omitempty" name:"MaxQueryCount"` // Dead letter queue name DeadLetterQueueName *string `json:"DeadLetterQueueName,omitempty" name:"DeadLetterQueueName"` // Maximum period in seconds before an unconsumed message expires, which is required if `MaxTimeToLivepolicy` is 1. Value range: 300–43200. This value should be smaller than `MsgRetentionSeconds` (maximum message retention period) MaxTimeToLive *uint64 `json:"MaxTimeToLive,omitempty" name:"MaxTimeToLive"` // Maximum number of receipts MaxReceiveCount *uint64 `json:"MaxReceiveCount,omitempty" name:"MaxReceiveCount"` // Dead letter queue policy Policy *uint64 `json:"Policy,omitempty" name:"Policy"` // Whether to enable message trace. true: yes, false: no. If this field is left empty, the feature will not be enabled. Trace *bool `json:"Trace,omitempty" name:"Trace"` }
func NewModifyQueueAttributeRequest ¶
func NewModifyQueueAttributeRequest() (request *ModifyQueueAttributeRequest)
func (*ModifyQueueAttributeRequest) FromJsonString ¶
func (r *ModifyQueueAttributeRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyQueueAttributeRequest) ToJsonString ¶
func (r *ModifyQueueAttributeRequest) ToJsonString() string
type ModifyQueueAttributeResponse ¶
type ModifyQueueAttributeResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyQueueAttributeResponse ¶
func NewModifyQueueAttributeResponse() (response *ModifyQueueAttributeResponse)
func (*ModifyQueueAttributeResponse) FromJsonString ¶
func (r *ModifyQueueAttributeResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyQueueAttributeResponse) ToJsonString ¶
func (r *ModifyQueueAttributeResponse) ToJsonString() string
type ModifySubscriptionAttributeRequest ¶
type ModifySubscriptionAttributeRequest struct { *tchttp.BaseRequest // Topic name, which is unique under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`). TopicName *string `json:"TopicName,omitempty" name:"TopicName"` // Subscription name, which is unique in the same topic under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`). SubscriptionName *string `json:"SubscriptionName,omitempty" name:"SubscriptionName"` // CMQ push server retry policy in case an error occurs while pushing a message to `Endpoint`. Valid values: // 1. BACKOFF_RETRY: backoff retry, which is to retry at a fixed interval, discard the message after a certain number of retries, and continue to push the next message. // 2. EXPONENTIAL_DECAY_RETRY: exponential decay retry, which is to retry at an exponentially increasing interval, such as 1s, 2s, 4s, 8s, and so on. As a message can be retained in a topic for one day, failed messages will be discarded at most after one day of retry. Default value: EXPONENTIAL_DECAY_RETRY. NotifyStrategy *string `json:"NotifyStrategy,omitempty" name:"NotifyStrategy"` // Push content format. Valid values: 1. JSON, 2. SIMPLIFIED, i.e., the raw format. If `Protocol` is `queue`, this value must be `SIMPLIFIED`. If `Protocol` is `HTTP`, both options are acceptable, and the default value is `JSON`. NotifyContentFormat *string `json:"NotifyContentFormat,omitempty" name:"NotifyContentFormat"` // Message body tag (used for message filtering). The number of tags cannot exceed 5, and each tag can contain up to 16 characters. It is used in conjunction with the `MsgTag` parameter of `(Batch)PublishMessage`. Rules: 1. If `FilterTag` is not set, no matter whether `MsgTag` is set, the subscription will receive all messages published to the topic; 2. If the `FilterTag` array has a value, only when at least one of the values in the array also exists in the `MsgTag` array (i.e., `FilterTag` and `MsgTag` have an intersection) can the subscription receive messages published to the topic; 3. If the `FilterTag` array has a value, but `MsgTag` is not set, then no message published to the topic will be received, which can be considered as a special case of rule 2 as `FilterTag` and `MsgTag` do not intersect in this case. The overall design idea of rules is based on the intention of the subscriber. FilterTags []*string `json:"FilterTags,omitempty" name:"FilterTags"` // The number of `BindingKey` cannot exceed 5, and the length of each `BindingKey` cannot exceed 64 bytes. This field indicates the filtering policy for subscribing to and receiving messages. Each `BindingKey` can contain up to 15 `.`, i.e., up to 16 phrases. BindingKey []*string `json:"BindingKey,omitempty" name:"BindingKey"` }
func NewModifySubscriptionAttributeRequest ¶
func NewModifySubscriptionAttributeRequest() (request *ModifySubscriptionAttributeRequest)
func (*ModifySubscriptionAttributeRequest) FromJsonString ¶
func (r *ModifySubscriptionAttributeRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifySubscriptionAttributeRequest) ToJsonString ¶
func (r *ModifySubscriptionAttributeRequest) ToJsonString() string
type ModifySubscriptionAttributeResponse ¶
type ModifySubscriptionAttributeResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifySubscriptionAttributeResponse ¶
func NewModifySubscriptionAttributeResponse() (response *ModifySubscriptionAttributeResponse)
func (*ModifySubscriptionAttributeResponse) FromJsonString ¶
func (r *ModifySubscriptionAttributeResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifySubscriptionAttributeResponse) ToJsonString ¶
func (r *ModifySubscriptionAttributeResponse) ToJsonString() string
type ModifyTopicAttributeRequest ¶
type ModifyTopicAttributeRequest struct { *tchttp.BaseRequest // Topic name, which is unique under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`). TopicName *string `json:"TopicName,omitempty" name:"TopicName"` // Maximum message length. Value range: 1024–65536 bytes (i.e., 1–64 KB). Default value: 65536. MaxMsgSize *uint64 `json:"MaxMsgSize,omitempty" name:"MaxMsgSize"` // Message retention period. Value range: 60–86400 seconds (i.e., 1 minute–1 day). Default value: 86400. MsgRetentionSeconds *uint64 `json:"MsgRetentionSeconds,omitempty" name:"MsgRetentionSeconds"` // Whether to enable message trace. true: yes, false: no. If this field is left empty, the feature will not be enabled. Trace *bool `json:"Trace,omitempty" name:"Trace"` }
func NewModifyTopicAttributeRequest ¶
func NewModifyTopicAttributeRequest() (request *ModifyTopicAttributeRequest)
func (*ModifyTopicAttributeRequest) FromJsonString ¶
func (r *ModifyTopicAttributeRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyTopicAttributeRequest) ToJsonString ¶
func (r *ModifyTopicAttributeRequest) ToJsonString() string
type ModifyTopicAttributeResponse ¶
type ModifyTopicAttributeResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyTopicAttributeResponse ¶
func NewModifyTopicAttributeResponse() (response *ModifyTopicAttributeResponse)
func (*ModifyTopicAttributeResponse) FromJsonString ¶
func (r *ModifyTopicAttributeResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyTopicAttributeResponse) ToJsonString ¶
func (r *ModifyTopicAttributeResponse) ToJsonString() string
type QueueSet ¶
type QueueSet struct { // QueueId QueueId *string `json:"QueueId,omitempty" name:"QueueId"` // QueueName QueueName *string `json:"QueueName,omitempty" name:"QueueName"` // Qps // Note: this field may return null, indicating that no valid values can be obtained. Qps *uint64 `json:"Qps,omitempty" name:"Qps"` // Bps // Note: this field may return null, indicating that no valid values can be obtained. Bps *uint64 `json:"Bps,omitempty" name:"Bps"` // MaxDelaySeconds // Note: this field may return null, indicating that no valid values can be obtained. MaxDelaySeconds *uint64 `json:"MaxDelaySeconds,omitempty" name:"MaxDelaySeconds"` // MaxMsgHeapNum // Note: this field may return null, indicating that no valid values can be obtained. MaxMsgHeapNum *uint64 `json:"MaxMsgHeapNum,omitempty" name:"MaxMsgHeapNum"` // PollingWaitSeconds // Note: this field may return null, indicating that no valid values can be obtained. PollingWaitSeconds *uint64 `json:"PollingWaitSeconds,omitempty" name:"PollingWaitSeconds"` // MsgRetentionSeconds // Note: this field may return null, indicating that no valid values can be obtained. MsgRetentionSeconds *uint64 `json:"MsgRetentionSeconds,omitempty" name:"MsgRetentionSeconds"` // VisibilityTimeout // Note: this field may return null, indicating that no valid values can be obtained. VisibilityTimeout *uint64 `json:"VisibilityTimeout,omitempty" name:"VisibilityTimeout"` // MaxMsgSize // Note: this field may return null, indicating that no valid values can be obtained. MaxMsgSize *uint64 `json:"MaxMsgSize,omitempty" name:"MaxMsgSize"` // RewindSeconds // Note: this field may return null, indicating that no valid values can be obtained. RewindSeconds *uint64 `json:"RewindSeconds,omitempty" name:"RewindSeconds"` // CreateTime // Note: this field may return null, indicating that no valid values can be obtained. CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"` // LastModifyTime // Note: this field may return null, indicating that no valid values can be obtained. LastModifyTime *uint64 `json:"LastModifyTime,omitempty" name:"LastModifyTime"` // ActiveMsgNum // Note: this field may return null, indicating that no valid values can be obtained. ActiveMsgNum *uint64 `json:"ActiveMsgNum,omitempty" name:"ActiveMsgNum"` // InactiveMsgNum // Note: this field may return null, indicating that no valid values can be obtained. InactiveMsgNum *uint64 `json:"InactiveMsgNum,omitempty" name:"InactiveMsgNum"` // DelayMsgNum // Note: this field may return null, indicating that no valid values can be obtained. DelayMsgNum *uint64 `json:"DelayMsgNum,omitempty" name:"DelayMsgNum"` // RewindMsgNum // Note: this field may return null, indicating that no valid values can be obtained. RewindMsgNum *uint64 `json:"RewindMsgNum,omitempty" name:"RewindMsgNum"` // MinMsgTime // Note: this field may return null, indicating that no valid values can be obtained. MinMsgTime *uint64 `json:"MinMsgTime,omitempty" name:"MinMsgTime"` // Transaction // Note: this field may return null, indicating that no valid values can be obtained. Transaction *bool `json:"Transaction,omitempty" name:"Transaction"` // DeadLetterSource // Note: this field may return null, indicating that no valid values can be obtained. DeadLetterSource []*DeadLetterSource `json:"DeadLetterSource,omitempty" name:"DeadLetterSource"` // DeadLetterPolicy // Note: this field may return null, indicating that no valid values can be obtained. DeadLetterPolicy *DeadLetterPolicy `json:"DeadLetterPolicy,omitempty" name:"DeadLetterPolicy"` // TransactionPolicy // Note: this field may return null, indicating that no valid values can be obtained. TransactionPolicy *TransactionPolicy `json:"TransactionPolicy,omitempty" name:"TransactionPolicy"` // Creator `uin` // Note: this field may return null, indicating that no valid values can be obtained. CreateUin *uint64 `json:"CreateUin,omitempty" name:"CreateUin"` // Tag // Note: this field may return null, indicating that no valid values can be obtained. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // Message trace flag. true: enabled, false: not enabled // Note: this field may return null, indicating that no valid values can be obtained. Trace *bool `json:"Trace,omitempty" name:"Trace"` }
type RewindQueueRequest ¶
type RewindQueueRequest struct { *tchttp.BaseRequest // Queue name, which is unique under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`). QueueName *string `json:"QueueName,omitempty" name:"QueueName"` // After this time is set, the `(Batch)receiveMessage` API will consume the messages received after this timestamp in the order in which they are produced. StartConsumeTime *uint64 `json:"StartConsumeTime,omitempty" name:"StartConsumeTime"` }
func NewRewindQueueRequest ¶
func NewRewindQueueRequest() (request *RewindQueueRequest)
func (*RewindQueueRequest) FromJsonString ¶
func (r *RewindQueueRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*RewindQueueRequest) ToJsonString ¶
func (r *RewindQueueRequest) ToJsonString() string
type RewindQueueResponse ¶
type RewindQueueResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewRewindQueueResponse ¶
func NewRewindQueueResponse() (response *RewindQueueResponse)
func (*RewindQueueResponse) FromJsonString ¶
func (r *RewindQueueResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*RewindQueueResponse) ToJsonString ¶
func (r *RewindQueueResponse) ToJsonString() string
type Subscription ¶
type Subscription struct { // SubscriptionName // Note: this field may return null, indicating that no valid values can be obtained. SubscriptionName *string `json:"SubscriptionName,omitempty" name:"SubscriptionName"` // SubscriptionId // Note: this field may return null, indicating that no valid values can be obtained. SubscriptionId *string `json:"SubscriptionId,omitempty" name:"SubscriptionId"` // TopicOwner // Note: this field may return null, indicating that no valid values can be obtained. TopicOwner *uint64 `json:"TopicOwner,omitempty" name:"TopicOwner"` // MsgCount // Note: this field may return null, indicating that no valid values can be obtained. MsgCount *uint64 `json:"MsgCount,omitempty" name:"MsgCount"` // LastModifyTime // Note: this field may return null, indicating that no valid values can be obtained. LastModifyTime *uint64 `json:"LastModifyTime,omitempty" name:"LastModifyTime"` // CreateTime // Note: this field may return null, indicating that no valid values can be obtained. CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"` // BindingKey // Note: this field may return null, indicating that no valid values can be obtained. BindingKey []*string `json:"BindingKey,omitempty" name:"BindingKey"` // Endpoint // Note: this field may return null, indicating that no valid values can be obtained. Endpoint *string `json:"Endpoint,omitempty" name:"Endpoint"` // FilterTags // Note: this field may return null, indicating that no valid values can be obtained. FilterTags []*string `json:"FilterTags,omitempty" name:"FilterTags"` // Protocol // Note: this field may return null, indicating that no valid values can be obtained. Protocol *string `json:"Protocol,omitempty" name:"Protocol"` // NotifyStrategy // Note: this field may return null, indicating that no valid values can be obtained. NotifyStrategy *string `json:"NotifyStrategy,omitempty" name:"NotifyStrategy"` // NotifyContentFormat // Note: this field may return null, indicating that no valid values can be obtained. NotifyContentFormat *string `json:"NotifyContentFormat,omitempty" name:"NotifyContentFormat"` }
type Tag ¶
type Tag struct { // Tag key // Note: this field may return null, indicating that no valid values can be obtained. TagKey *string `json:"TagKey,omitempty" name:"TagKey"` // Tag value // Note: this field may return null, indicating that no valid values can be obtained. TagValue *string `json:"TagValue,omitempty" name:"TagValue"` }
type TopicSet ¶
type TopicSet struct { // TopicId // Note: this field may return null, indicating that no valid values can be obtained. TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // TopicName // Note: this field may return null, indicating that no valid values can be obtained. TopicName *string `json:"TopicName,omitempty" name:"TopicName"` // MsgRetentionSeconds // Note: this field may return null, indicating that no valid values can be obtained. MsgRetentionSeconds *uint64 `json:"MsgRetentionSeconds,omitempty" name:"MsgRetentionSeconds"` // MaxMsgSize // Note: this field may return null, indicating that no valid values can be obtained. MaxMsgSize *uint64 `json:"MaxMsgSize,omitempty" name:"MaxMsgSize"` // Qps // Note: this field may return null, indicating that no valid values can be obtained. Qps *uint64 `json:"Qps,omitempty" name:"Qps"` // FilterType // Note: this field may return null, indicating that no valid values can be obtained. FilterType *uint64 `json:"FilterType,omitempty" name:"FilterType"` // CreateTime // Note: this field may return null, indicating that no valid values can be obtained. CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"` // LastModifyTime // Note: this field may return null, indicating that no valid values can be obtained. LastModifyTime *uint64 `json:"LastModifyTime,omitempty" name:"LastModifyTime"` // MsgCount // Note: this field may return null, indicating that no valid values can be obtained. MsgCount *uint64 `json:"MsgCount,omitempty" name:"MsgCount"` // CreateUin // Note: this field may return null, indicating that no valid values can be obtained. CreateUin *uint64 `json:"CreateUin,omitempty" name:"CreateUin"` // Tags // Note: this field may return null, indicating that no valid values can be obtained. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // Whether to enable message trace for a topic. true: yes, false: no // Note: this field may return null, indicating that no valid values can be obtained. Trace *bool `json:"Trace,omitempty" name:"Trace"` }
type TransactionPolicy ¶
type TransactionPolicy struct { // FirstQueryInterval // Note: this field may return null, indicating that no valid values can be obtained. FirstQueryInterval *uint64 `json:"FirstQueryInterval,omitempty" name:"FirstQueryInterval"` // MaxQueryCount // Note: this field may return null, indicating that no valid values can be obtained. MaxQueryCount *uint64 `json:"MaxQueryCount,omitempty" name:"MaxQueryCount"` }
type UnbindDeadLetterRequest ¶
type UnbindDeadLetterRequest struct { *tchttp.BaseRequest // Source queue name of dead letter policy. Calling this API will clear the dead letter queue policy of this queue. QueueName *string `json:"QueueName,omitempty" name:"QueueName"` }
func NewUnbindDeadLetterRequest ¶
func NewUnbindDeadLetterRequest() (request *UnbindDeadLetterRequest)
func (*UnbindDeadLetterRequest) FromJsonString ¶
func (r *UnbindDeadLetterRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UnbindDeadLetterRequest) ToJsonString ¶
func (r *UnbindDeadLetterRequest) ToJsonString() string
type UnbindDeadLetterResponse ¶
type UnbindDeadLetterResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewUnbindDeadLetterResponse ¶
func NewUnbindDeadLetterResponse() (response *UnbindDeadLetterResponse)
func (*UnbindDeadLetterResponse) FromJsonString ¶
func (r *UnbindDeadLetterResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UnbindDeadLetterResponse) ToJsonString ¶
func (r *UnbindDeadLetterResponse) ToJsonString() string