model

package
v0.0.88 Latest Latest
Warning

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

Go to latest
Published: May 13, 2022 License: Apache-2.0, BSD-2-Clause, BSD-3-Clause Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BatchCreateOrDeleteQueueTagRequest

type BatchCreateOrDeleteQueueTagRequest struct {

	// 队列ID。
	QueueId string `json:"queue_id"`

	Body *BatchCreateOrDeleteTagReq `json:"body,omitempty"`
}

Request Object

func (BatchCreateOrDeleteQueueTagRequest) String

type BatchCreateOrDeleteQueueTagResponse

type BatchCreateOrDeleteQueueTagResponse struct {
	HttpStatusCode int `json:"-"`
}

Response Object

func (BatchCreateOrDeleteQueueTagResponse) String

type BatchCreateOrDeleteTagReq

type BatchCreateOrDeleteTagReq struct {

	// 操作标识(仅支持小写): - create(创建) - delete(删除)
	Action *BatchCreateOrDeleteTagReqAction `json:"action,omitempty"`

	// 标签列表。
	Tags *[]BatchCreateOrDeleteTagReqTags `json:"tags,omitempty"`
}

func (BatchCreateOrDeleteTagReq) String

func (o BatchCreateOrDeleteTagReq) String() string

type BatchCreateOrDeleteTagReqAction

type BatchCreateOrDeleteTagReqAction struct {
	// contains filtered or unexported fields
}

func (BatchCreateOrDeleteTagReqAction) MarshalJSON

func (c BatchCreateOrDeleteTagReqAction) MarshalJSON() ([]byte, error)

func (*BatchCreateOrDeleteTagReqAction) UnmarshalJSON

func (c *BatchCreateOrDeleteTagReqAction) UnmarshalJSON(b []byte) error

type BatchCreateOrDeleteTagReqActionEnum

type BatchCreateOrDeleteTagReqActionEnum struct {
	CREATE BatchCreateOrDeleteTagReqAction
	DELETE BatchCreateOrDeleteTagReqAction
}

func GetBatchCreateOrDeleteTagReqActionEnum

func GetBatchCreateOrDeleteTagReqActionEnum() BatchCreateOrDeleteTagReqActionEnum

type BatchCreateOrDeleteTagReqTags

type BatchCreateOrDeleteTagReqTags struct {

	// 键。最大长度36个unicode字符。  key不能为空,不能为空字符串。  不能包含下列字符:非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\\”,“,”,“|”,“/”。
	Key *string `json:"key,omitempty"`

	// 值。每个值最大长度43个unicode字符。  value不能为空,可以空字符串。  不能包含下列字符:非打印字符ASCII(0-31), “=”,“*”,“<”,“>”,“\\”,“,”,“|”,“/”。
	Value *string `json:"value,omitempty"`
}

func (BatchCreateOrDeleteTagReqTags) String

type ConfirmConsumptionMessagesReq

type ConfirmConsumptionMessagesReq struct {

	// 确认消息数组。
	Message *[]ConfirmMessageEntity `json:"message,omitempty"`
}

func (ConfirmConsumptionMessagesReq) String

type ConfirmConsumptionMessagesRequest

type ConfirmConsumptionMessagesRequest struct {

	// 队列ID。
	QueueId string `json:"queue_id"`

	// 消费组ID。
	ConsumerGroupId string `json:"consumer_group_id"`

	Body *ConfirmConsumptionMessagesReq `json:"body,omitempty"`
}

Request Object

func (ConfirmConsumptionMessagesRequest) String

type ConfirmConsumptionMessagesResponse

type ConfirmConsumptionMessagesResponse struct {

	// 确认成功的数目(如果为N,则表示前N条消息确认成功)。
	Success *int32 `json:"success,omitempty"`

	// 确认失败的数目(如果为N,则表示后N条消息确认失败)。
	Fail           *int32 `json:"fail,omitempty"`
	HttpStatusCode int    `json:"-"`
}

Response Object

func (ConfirmConsumptionMessagesResponse) String

type ConfirmDeadLettersMessagesReq

type ConfirmDeadLettersMessagesReq struct {

	// 确认消息数组。
	Message *[]ConfirmMessageEntity `json:"message,omitempty"`
}

func (ConfirmDeadLettersMessagesReq) String

type ConfirmDeadLettersMessagesRequest

type ConfirmDeadLettersMessagesRequest struct {

	// 队列ID。
	QueueId string `json:"queue_id"`

	// 消费组ID。
	ConsumerGroupId string `json:"consumer_group_id"`

	Body *ConfirmDeadLettersMessagesReq `json:"body,omitempty"`
}

Request Object

func (ConfirmDeadLettersMessagesRequest) String

type ConfirmDeadLettersMessagesResponse

type ConfirmDeadLettersMessagesResponse struct {

	// 确认成功的数目(如果为N,则表示前N条消息确认成功)。
	Success *int32 `json:"success,omitempty"`

	// 确认失败的数目(如果为N,则表示后N条消息确认失败)。
	Fail           *int32 `json:"fail,omitempty"`
	HttpStatusCode int    `json:"-"`
}

Response Object

func (ConfirmDeadLettersMessagesResponse) String

type ConfirmMessageEntity added in v0.0.79

type ConfirmMessageEntity struct {

	// 消费时返回的ID。
	Handler *string `json:"handler,omitempty"`

	// 客户端处理数据的状态。 取值为“success”或者“fail”。
	Status *ConfirmMessageEntityStatus `json:"status,omitempty"`
}

func (ConfirmMessageEntity) String added in v0.0.79

func (o ConfirmMessageEntity) String() string

type ConfirmMessageEntityStatus added in v0.0.79

type ConfirmMessageEntityStatus struct {
	// contains filtered or unexported fields
}

func (ConfirmMessageEntityStatus) MarshalJSON added in v0.0.79

func (c ConfirmMessageEntityStatus) MarshalJSON() ([]byte, error)

func (*ConfirmMessageEntityStatus) UnmarshalJSON added in v0.0.79

func (c *ConfirmMessageEntityStatus) UnmarshalJSON(b []byte) error

type ConfirmMessageEntityStatusEnum added in v0.0.79

type ConfirmMessageEntityStatusEnum struct {
	SUCCESS ConfirmMessageEntityStatus
	FAIL    ConfirmMessageEntityStatus
}

func GetConfirmMessageEntityStatusEnum added in v0.0.79

func GetConfirmMessageEntityStatusEnum() ConfirmMessageEntityStatusEnum

type ConsumeDeadlettersMessage

type ConsumeDeadlettersMessage struct {
	Message *ConsumeDeadlettersMessageMessage `json:"message,omitempty"`

	// 消息handler。
	Handler *string `json:"handler,omitempty"`
}

func (ConsumeDeadlettersMessage) String

func (o ConsumeDeadlettersMessage) String() string

type ConsumeDeadlettersMessageMessage

type ConsumeDeadlettersMessageMessage struct {

	// 消息体的内容。
	Body *interface{} `json:"body,omitempty"`

	// 属性的列表。
	Attributes *interface{} `json:"attributes,omitempty"`
}

消息的内容。

func (ConsumeDeadlettersMessageMessage) String

type ConsumeDeadlettersMessageRequest

type ConsumeDeadlettersMessageRequest struct {

	// 指定的队列ID。
	QueueId string `json:"queue_id"`

	// 消费组的ID。
	ConsumerGroupId string `json:"consumer_group_id"`

	// 获取可消费的死信消息的条数。  >单次消费返回的消息数量可能会少于指定条数,但多次消费最终可获取全部消息。  取值范围:1~10。  默认值:10
	MaxMsgs *int32 `json:"max_msgs,omitempty"`

	// 设定消费组中可消费的死信为0时的读取消息等待时间。  如果在等待时间内有新的死信消息,则立即返回消费结果,如果等待时间内没有新的死信消息,则到等待时间后返回消费结果。  取值范围:1~60s  默认值:3s  说明:不带该参数或者配置为空,都默认为3s。
	TimeWait *int32 `json:"time_wait,omitempty"`

	// commit提交超时时间,在该时间内提交确认,确认有效,如果超过指定时间,系统会报消息确认超时,或handler无效。  取值范围:15~300s  默认值:30s  说明:不带该参数或者配置为空,都默认为30s。
	AckWait *int32 `json:"ack_wait,omitempty"`
}

Request Object

func (ConsumeDeadlettersMessageRequest) String

type ConsumeDeadlettersMessageResponse

type ConsumeDeadlettersMessageResponse struct {

	// 消息数组。
	Body           *[]ConsumeDeadlettersMessage `json:"body,omitempty"`
	HttpStatusCode int                          `json:"-"`
}

Response Object

func (ConsumeDeadlettersMessageResponse) String

type ConsumeMessage

type ConsumeMessage struct {
	Message *ConsumeMessageMessage `json:"message,omitempty"`

	// 消息handler。
	Handler *string `json:"handler,omitempty"`
}

func (ConsumeMessage) String

func (o ConsumeMessage) String() string

type ConsumeMessageMessage

type ConsumeMessageMessage struct {

	// 消息体的内容。
	Body *interface{} `json:"body,omitempty"`

	// 属性的列表。
	Attributes *interface{} `json:"attributes,omitempty"`

	// 标签值。
	Tags *[]string `json:"tags,omitempty"`
}

消息的内容。

func (ConsumeMessageMessage) String

func (o ConsumeMessageMessage) String() string

type ConsumeMessagesRequest

type ConsumeMessagesRequest struct {

	// 指定的队列ID。
	QueueId string `json:"queue_id"`

	// 消费组的ID。
	ConsumerGroupId string `json:"consumer_group_id"`

	// 获取可消费的消息的条数。  取值范围:1~10。  默认值:10
	MaxMsgs *int32 `json:"max_msgs,omitempty"`

	// 设定队列可消费的消息为0时的读取消息等待时间。  如果在等待时间内有新的消息,则立即返回消费结果,如果等待时间内没有新的消息,则到等待时间后返回消费结果。  取值范围:1~60s  默认值:3s  说明:不带该参数或者配置为空,都默认为3s。
	TimeWait *int32 `json:"time_wait,omitempty"`

	// 提交确认消费的超时时间,客户端需要在该时间内提交消费确认,如果超过指定时间,没有确认消费,系统会报消息确认超时或handler无效,则默认为消费失败。  取值范围:15~300s  默认值:30s  说明:不带该参数或者配置为空,都默认为30s。
	AckWait *int32 `json:"ack_wait,omitempty"`

	// 添加标签后可以按照Tag进行过滤,只消费匹配上标签的消息。  Tag的数量不超过3个。  每个Tag长度不超过64。
	Tag *string `json:"tag,omitempty"`

	// 多个消息标签的过滤类型。  取值范围: - and:必须所有标签匹配上,才能消费消息。 - or:只要有一条标签匹配上,就可以消费消息。  默认值为:or。
	TagType *string `json:"tag_type,omitempty"`
}

Request Object

func (ConsumeMessagesRequest) String

func (o ConsumeMessagesRequest) String() string

type ConsumeMessagesResponse

type ConsumeMessagesResponse struct {

	// 消息数组。
	Body           *[]ConsumeMessage `json:"body,omitempty"`
	HttpStatusCode int               `json:"-"`
}

Response Object

func (ConsumeMessagesResponse) String

func (o ConsumeMessagesResponse) String() string

type CreateConsumerGroupReq

type CreateConsumerGroupReq struct {

	// 消费组信息。  每个队列最多能创建3个消费组,如果请求中的消费组个数超过3个,请求校验不通过,无法创建消费组。
	Groups []GroupEntity `json:"groups"`
}

func (CreateConsumerGroupReq) String

func (o CreateConsumerGroupReq) String() string

type CreateConsumerGroupRequest

type CreateConsumerGroupRequest struct {

	// 指定的队列ID
	QueueId string `json:"queue_id"`

	Body *CreateConsumerGroupReq `json:"body,omitempty"`
}

Request Object

func (CreateConsumerGroupRequest) String

type CreateConsumerGroupRespGroups

type CreateConsumerGroupRespGroups struct {

	// 消费组的ID。
	Id *string `json:"id,omitempty"`

	// 消费组的名称。
	Name *string `json:"name,omitempty"`
}

func (CreateConsumerGroupRespGroups) String

type CreateConsumerGroupResponse

type CreateConsumerGroupResponse struct {

	// 消费组信息。
	Groups         *[]CreateConsumerGroupRespGroups `json:"groups,omitempty"`
	HttpStatusCode int                              `json:"-"`
}

Response Object

func (CreateConsumerGroupResponse) String

type CreateQueueReq

type CreateQueueReq struct {

	// 队列的名称,必须唯一。  长度不超过64位的字符串,包含a~z,A~Z,0~9、中划线(-)和下划线(_)。  创建队列后无法修改名称。
	Name string `json:"name"`

	// 队列类型。  取值范围: - NORMAL:普通队列,更高的并发性能,不保证先入先出(FIFO)的严格顺序。 - FIFO:有序队列,保证消息先入先出(FIFO)的严格顺序。 - KAFKA_HA:高可靠模式的kafka队列。消息多副本同步落盘,保证消息的可靠性。 - KAFKA_HT:高吞吐模式的kafka队列。消息副本异步落盘,具有较高的性能。  默认值:NORMAL
	QueueMode *CreateQueueReqQueueMode `json:"queue_mode,omitempty"`

	// 队列的描述信息。  长度不超过160位的字符串,不能包含尖括号<>。
	Description *string `json:"description,omitempty"`

	// 仅当queue_mode为“NORMAL”或者“FIFO”时,该参数有效。  是否开启死信消息,死信消息是指无法被正常消费的消息。  当达到最大消费次数仍然失败后,DMS会将该条消息转存到死信队列中,有效期为72小时,用户可以根据需要对死信消息进行重新消费。  消费死信消息时,只能消费该消费组产生的死信消息。  有序队列的死信消息依然按照先入先出(FIFO)的顺序存储在死信队列中。  取值范围: - enable:开启 - disable:不开启  默认值:disable
	RedrivePolicy *CreateQueueReqRedrivePolicy `json:"redrive_policy,omitempty"`

	// 仅当redrive_policy为enable时,该参数必选。  最大确认消费失败的次数,当达到最大确认失败次数后,DMS会将该条消息转存到死信队列中。  取值范围:1~100
	MaxConsumeCount *int32 `json:"max_consume_count,omitempty"`

	// 指定kafka队列的消息保存时间,单位为小时。  仅当queue_mode为KAFKA_HA或者KAFKA_HT才有效。  取值范围: 1-72(小时)
	RetentionHours *int32 `json:"retention_hours,omitempty"`
}

func (CreateQueueReq) String

func (o CreateQueueReq) String() string

type CreateQueueReqQueueMode

type CreateQueueReqQueueMode struct {
	// contains filtered or unexported fields
}

func (CreateQueueReqQueueMode) MarshalJSON

func (c CreateQueueReqQueueMode) MarshalJSON() ([]byte, error)

func (*CreateQueueReqQueueMode) UnmarshalJSON

func (c *CreateQueueReqQueueMode) UnmarshalJSON(b []byte) error

type CreateQueueReqQueueModeEnum

type CreateQueueReqQueueModeEnum struct {
	NORMAL   CreateQueueReqQueueMode
	FIFO     CreateQueueReqQueueMode
	KAFKA_HA CreateQueueReqQueueMode
	KAFKA_HT CreateQueueReqQueueMode
}

func GetCreateQueueReqQueueModeEnum

func GetCreateQueueReqQueueModeEnum() CreateQueueReqQueueModeEnum

type CreateQueueReqRedrivePolicy

type CreateQueueReqRedrivePolicy struct {
	// contains filtered or unexported fields
}

func (CreateQueueReqRedrivePolicy) MarshalJSON

func (c CreateQueueReqRedrivePolicy) MarshalJSON() ([]byte, error)

func (*CreateQueueReqRedrivePolicy) UnmarshalJSON

func (c *CreateQueueReqRedrivePolicy) UnmarshalJSON(b []byte) error

type CreateQueueReqRedrivePolicyEnum

type CreateQueueReqRedrivePolicyEnum struct {
	ENABLE  CreateQueueReqRedrivePolicy
	DISABLE CreateQueueReqRedrivePolicy
}

func GetCreateQueueReqRedrivePolicyEnum

func GetCreateQueueReqRedrivePolicyEnum() CreateQueueReqRedrivePolicyEnum

type CreateQueueRequest

type CreateQueueRequest struct {
	Body *CreateQueueReq `json:"body,omitempty"`
}

Request Object

func (CreateQueueRequest) String

func (o CreateQueueRequest) String() string

type CreateQueueResponse

type CreateQueueResponse struct {

	// 队列ID。
	Id *string `json:"id,omitempty"`

	// 队列的名称。
	Name *string `json:"name,omitempty"`

	// 仅Kafka队列才有该响应参数。  使用Kafka SDK时的Kafka topic的ID。
	KafkaTopic     *string `json:"kafka_topic,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (CreateQueueResponse) String

func (o CreateQueueResponse) String() string

type DeleteQueueRequest

type DeleteQueueRequest struct {

	// 待删除的队列ID
	QueueId string `json:"queue_id"`
}

Request Object

func (DeleteQueueRequest) String

func (o DeleteQueueRequest) String() string

type DeleteQueueResponse

type DeleteQueueResponse struct {
	HttpStatusCode int `json:"-"`
}

Response Object

func (DeleteQueueResponse) String

func (o DeleteQueueResponse) String() string

type DeleteSpecifiedConsumerGroupRequest

type DeleteSpecifiedConsumerGroupRequest struct {

	// 队列ID
	QueueId string `json:"queue_id"`

	// 待删除的消费组ID
	GroupId string `json:"group_id"`
}

Request Object

func (DeleteSpecifiedConsumerGroupRequest) String

type DeleteSpecifiedConsumerGroupResponse

type DeleteSpecifiedConsumerGroupResponse struct {
	HttpStatusCode int `json:"-"`
}

Response Object

func (DeleteSpecifiedConsumerGroupResponse) String

type GroupEntity

type GroupEntity struct {

	// 消费组的名称。  长度不超过32位的字符串,仅包含a~z,A~Z,0~9、下划线(_)和中划线(-)。
	Name string `json:"name"`
}

func (GroupEntity) String

func (o GroupEntity) String() string

type ListConsumerGroupsRequest

type ListConsumerGroupsRequest struct {

	// 指定的队列ID
	QueueId string `json:"queue_id"`

	// 是否包含死信信息。默认值为:false
	IncludeDeadletter *bool `json:"include_deadletter,omitempty"`

	// 是否查询消费组的详情,默认值为true。  配置为false时,查询的消费组列表不包含消费详情,接口响应速度快。
	IncludeMessagesNum *bool `json:"include_messages_num,omitempty"`

	// 设置每页显示的消费组数量。  page_size和current_page必须同时配置有效值,否则默认查询所有消费组。
	PageSize *int32 `json:"page_size,omitempty"`

	// 设置查询消费组的页码。  page_size和current_page必须同时配置有效值,否则默认查询所有消费组。
	CurrentPage *int32 `json:"current_page,omitempty"`
}

Request Object

func (ListConsumerGroupsRequest) String

func (o ListConsumerGroupsRequest) String() string

type ListConsumerGroupsResponse

type ListConsumerGroupsResponse struct {

	// 队列ID。
	QueueId *string `json:"queue_id,omitempty"`

	// 队列的名称。
	QueueName *string `json:"queue_name,omitempty"`

	// 消费组列表。
	Groups *[]ListQueueGroupsRespGroups `json:"groups,omitempty"`

	// 该队列是否开启死信消息。仅当include_deadletter为true时,才有该响应参数。 - enable:表示开启。 - disable:表示不开启。
	RedrivePolicy  *ListConsumerGroupsResponseRedrivePolicy `json:"redrive_policy,omitempty"`
	HttpStatusCode int                                      `json:"-"`
}

Response Object

func (ListConsumerGroupsResponse) String

type ListConsumerGroupsResponseRedrivePolicy

type ListConsumerGroupsResponseRedrivePolicy struct {
	// contains filtered or unexported fields
}

func (ListConsumerGroupsResponseRedrivePolicy) MarshalJSON

func (c ListConsumerGroupsResponseRedrivePolicy) MarshalJSON() ([]byte, error)

func (*ListConsumerGroupsResponseRedrivePolicy) UnmarshalJSON

func (c *ListConsumerGroupsResponseRedrivePolicy) UnmarshalJSON(b []byte) error

type ListConsumerGroupsResponseRedrivePolicyEnum

type ListConsumerGroupsResponseRedrivePolicyEnum struct {
	ENABLE  ListConsumerGroupsResponseRedrivePolicy
	DISABLE ListConsumerGroupsResponseRedrivePolicy
}

func GetListConsumerGroupsResponseRedrivePolicyEnum

func GetListConsumerGroupsResponseRedrivePolicyEnum() ListConsumerGroupsResponseRedrivePolicyEnum

type ListQueueGroupsRespGroups

type ListQueueGroupsRespGroups struct {

	// 队列的名称。
	Id *string `json:"id,omitempty"`

	// 队列的名称。
	Name *string `json:"name,omitempty"`

	// 队列的消息总数,不包含过期删除的消息数。
	ProducedMessages *int32 `json:"produced_messages,omitempty"`

	// 已正常消费的消息总数。
	ConsumedMessages *int32 `json:"consumed_messages,omitempty"`

	// 该消费组可以消费的普通消息数。
	AvailableMessages *int32 `json:"available_messages,omitempty"`

	// 该消费组产生的死信息消息总数。仅当include_deadletter为true时,才有该响应参数。
	ProducedDeadletters *int32 `json:"produced_deadletters,omitempty"`

	// 该消费组未消费的死信消息数。仅当include_deadletter为true时,才有该响应参数。
	AvailableDeadletters *int32 `json:"available_deadletters,omitempty"`
}

消费组信息

func (ListQueueGroupsRespGroups) String

func (o ListQueueGroupsRespGroups) String() string

type ListQueuesRequest

type ListQueuesRequest struct {

	// 是否包含死信信息。  支持的值如下:  - true:包含死信消息。 - false:不包含死信消息。  默认值为:false。  Kafka队列没有死信功能,该参数对于Kafka队列无效。
	IncludeDeadletter *bool `json:"include_deadletter,omitempty"`
}

Request Object

func (ListQueuesRequest) String

func (o ListQueuesRequest) String() string

type ListQueuesRespQueues

type ListQueuesRespQueues struct {

	// 队列ID。
	Id *string `json:"id,omitempty"`

	// 队列的名称。
	Name *string `json:"name,omitempty"`

	// 创建队列的时间。
	Created *int64 `json:"created,omitempty"`

	// 队列的描述信息。
	Description *string `json:"description,omitempty"`

	// 队列类型。
	QueueMode *string `json:"queue_mode,omitempty"`

	// 消息在队列中允许保留的时长(单位分钟)。
	Reservation *int32 `json:"reservation,omitempty"`

	// 队列中允许的最大消息大小(单位Byte)。
	MaxMsgSizeByte *int32 `json:"max_msg_size_byte,omitempty"`

	// 队列的消息总数。
	ProducedMessages *int32 `json:"produced_messages,omitempty"`

	// 该队列是否开启死信消息。仅当include_deadletter为true时,才有该响应参数。 - enable:表示开启。 - disable:表示不开启。
	RedrivePolicy *string `json:"redrive_policy,omitempty"`

	// 最大确认消费失败的次数,当达到最大确认失败次数后,DMS会将该条消息转存到死信队列中。  仅当include_deadletter为true时,才有该响应参数。
	MaxConsumeCount *int32 `json:"max_consume_count,omitempty"`

	// 该队列下的消费组数量。
	GroupCount *int32 `json:"group_count,omitempty"`

	// 创建队列的时间。
	EffDate *int64 `json:"eff_date,omitempty"`
}

func (ListQueuesRespQueues) String

func (o ListQueuesRespQueues) String() string

type ListQueuesResponse

type ListQueuesResponse struct {

	// 该租户的所有队列总数。
	Total *int32 `json:"total,omitempty"`

	// 该租户的所有队列数组。
	Queues         *[]ListQueuesRespQueues `json:"queues,omitempty"`
	HttpStatusCode int                     `json:"-"`
}

Response Object

func (ListQueuesResponse) String

func (o ListQueuesResponse) String() string

type SendMessageEntity

type SendMessageEntity struct {

	// 消息正文。
	Body *interface{} `json:"body"`

	// 属性列表,包含属性名称和属性值。  同一条消息的属性名称不可重复,否则属性值将被覆盖。
	Attributes *interface{} `json:"attributes,omitempty"`

	// 消息标签,即Label,是通过对消息增加Label来区分队列中的消息分类,DMS允许消费者按照Label对消息进行过滤,确保消费者最终只消费到他关心的消息类型。  消息标签只能包含a~z,A~Z,0-9,-,_,长度是[1,64]。  最多可添加3个标签。
	Tags *interface{} `json:"tags,omitempty"`

	// 延时消息的延时时长。  延时消息是指消息发送到DMS服务后,并不期望这条消息立即被消费,而是延迟一段时间后才能被消费。  取值范围:0~604800000  单位:毫秒  不配置该参数或者配置为0,表示无延时。  配置为浮点数时,自动取小数点前面的整数值,比如配置为6000.9,则自动取值为6000。  仅NORMAL队列和FIFO队列可以设置延时消息,Kafka队列不支持延时消息的功能,如果向Kafka队列生产延时消息,提示{\"code\":10540010, \"message\":\"Invalid request format: kafka queue message could not have delayTime.\"}。
	DelayTime *interface{} `json:"delay_time,omitempty"`
}

func (SendMessageEntity) String

func (o SendMessageEntity) String() string

type SendMessagesReq

type SendMessagesReq struct {

	// 发送消息成功后,是否返回Message ID,默认为false,设置为true时,返回参数才有Message ID。
	ReturnId *bool `json:"return_id,omitempty"`

	// 消息列表。
	Messages []SendMessageEntity `json:"messages"`
}

func (SendMessagesReq) String

func (o SendMessagesReq) String() string

type SendMessagesRequest

type SendMessagesRequest struct {

	// 指定的队列ID。
	QueueId string `json:"queue_id"`

	Body *SendMessagesReq `json:"body,omitempty"`
}

Request Object

func (SendMessagesRequest) String

func (o SendMessagesRequest) String() string

type SendMessagesRespMessages

type SendMessagesRespMessages struct {

	// 错误描述信息。
	Error *string `json:"error,omitempty"`

	// 错误码。
	ErrorCode *int32 `json:"error_code,omitempty"`

	// 发送消息的状态。 0:表示发送成功。 1:表示发送失败,失败原因参考对应的error和error_code。
	State *int32 `json:"state,omitempty"`

	// 消息ID。
	Id *string `json:"id,omitempty"`
}

func (SendMessagesRespMessages) String

func (o SendMessagesRespMessages) String() string

type SendMessagesResponse

type SendMessagesResponse struct {

	// 消息列表。
	Messages       *[]SendMessagesRespMessages `json:"messages,omitempty"`
	HttpStatusCode int                         `json:"-"`
}

Response Object

func (SendMessagesResponse) String

func (o SendMessagesResponse) String() string

type ShowProjectTagsRespTags

type ShowProjectTagsRespTags struct {

	// 键。最大长度36个unicode字符。  key不能为空,不能为空字符串。  不能包含下列字符:非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\\”,“,”,“|”,“/”。
	Key *string `json:"key,omitempty"`

	// 值。每个值最大长度43个unicode字符。  value不能为空,可以空字符串。  不能包含下列字符:非打印字符ASCII(0-31), “=”,“*”,“<”,“>”,“\\”,“,”,“|”,“/”。
	Values *[]string `json:"values,omitempty"`
}

func (ShowProjectTagsRespTags) String

func (o ShowProjectTagsRespTags) String() string

type ShowQueueProjectTagsRequest

type ShowQueueProjectTagsRequest struct {
}

Request Object

func (ShowQueueProjectTagsRequest) String

type ShowQueueProjectTagsResponse

type ShowQueueProjectTagsResponse struct {

	// 标签列表
	Tags           *[]ShowProjectTagsRespTags `json:"tags,omitempty"`
	HttpStatusCode int                        `json:"-"`
}

Response Object

func (ShowQueueProjectTagsResponse) String

type ShowQueueRequest

type ShowQueueRequest struct {

	// 待查询的队列ID
	QueueId string `json:"queue_id"`

	// 是否包含死信信息。  支持的值如下:  - true:包含死信消息。 - false:不包含死信消息。  默认值为:false。  Kafka队列没有死信功能,该参数对于Kafka队列无效。
	IncludeDeadletter *bool `json:"include_deadletter,omitempty"`
}

Request Object

func (ShowQueueRequest) String

func (o ShowQueueRequest) String() string

type ShowQueueResponse

type ShowQueueResponse struct {

	// 队列ID。
	Id *string `json:"id,omitempty"`

	// 队列的名称。
	Name *string `json:"name,omitempty"`

	// 创建队列的时间。
	Created *int64 `json:"created,omitempty"`

	// 队列的描述信息。
	Description *string `json:"description,omitempty"`

	// 队列类型。
	QueueMode *ShowQueueResponseQueueMode `json:"queue_mode,omitempty"`

	// 消息在队列中允许保留的时长(单位分钟)。
	Reservation *int32 `json:"reservation,omitempty"`

	// 队列中允许的最大消息大小(单位Byte)。
	MaxMsgSizeByte *int32 `json:"max_msg_size_byte,omitempty"`

	// 队列的消息总数。
	ProducedMessages *int32 `json:"produced_messages,omitempty"`

	// 该队列是否开启死信消息。仅当include_deadletter为true时,才有该响应参数。 - enable:表示开启。 - disable:表示不开启。
	RedrivePolicy *ShowQueueResponseRedrivePolicy `json:"redrive_policy,omitempty"`

	// 最大确认消费失败的次数,当达到最大确认失败次数后,DMS会将该条消息转存到死信队列中。 仅当include_deadletter为true时,才有该响应参数。
	MaxConsumeCount *int32 `json:"max_consume_count,omitempty"`

	// 该队列下的消费组数量。
	GroupCount *int32 `json:"group_count,omitempty"`

	// 仅Kafka队列才有该参数。
	KafkaTopic *string `json:"kafka_topic,omitempty"`

	// 创建队列的时间。
	EffDate        *int64 `json:"eff_date,omitempty"`
	HttpStatusCode int    `json:"-"`
}

Response Object

func (ShowQueueResponse) String

func (o ShowQueueResponse) String() string

type ShowQueueResponseQueueMode

type ShowQueueResponseQueueMode struct {
	// contains filtered or unexported fields
}

func (ShowQueueResponseQueueMode) MarshalJSON

func (c ShowQueueResponseQueueMode) MarshalJSON() ([]byte, error)

func (*ShowQueueResponseQueueMode) UnmarshalJSON

func (c *ShowQueueResponseQueueMode) UnmarshalJSON(b []byte) error

type ShowQueueResponseQueueModeEnum

type ShowQueueResponseQueueModeEnum struct {
	NORMAL   ShowQueueResponseQueueMode
	FIFO     ShowQueueResponseQueueMode
	KAFKA_HA ShowQueueResponseQueueMode
	KAFKA_HT ShowQueueResponseQueueMode
}

func GetShowQueueResponseQueueModeEnum

func GetShowQueueResponseQueueModeEnum() ShowQueueResponseQueueModeEnum

type ShowQueueResponseRedrivePolicy

type ShowQueueResponseRedrivePolicy struct {
	// contains filtered or unexported fields
}

func (ShowQueueResponseRedrivePolicy) MarshalJSON

func (c ShowQueueResponseRedrivePolicy) MarshalJSON() ([]byte, error)

func (*ShowQueueResponseRedrivePolicy) UnmarshalJSON

func (c *ShowQueueResponseRedrivePolicy) UnmarshalJSON(b []byte) error

type ShowQueueResponseRedrivePolicyEnum

type ShowQueueResponseRedrivePolicyEnum struct {
	ENABLE  ShowQueueResponseRedrivePolicy
	DISABLE ShowQueueResponseRedrivePolicy
}

func GetShowQueueResponseRedrivePolicyEnum

func GetShowQueueResponseRedrivePolicyEnum() ShowQueueResponseRedrivePolicyEnum

type ShowQueueTagsRequest

type ShowQueueTagsRequest struct {

	// 队列ID。
	QueueId string `json:"queue_id"`
}

Request Object

func (ShowQueueTagsRequest) String

func (o ShowQueueTagsRequest) String() string

type ShowQueueTagsResponse

type ShowQueueTagsResponse struct {

	// 标签列表
	Tags           *[]BatchCreateOrDeleteTagReqTags `json:"tags,omitempty"`
	HttpStatusCode int                              `json:"-"`
}

Response Object

func (ShowQueueTagsResponse) String

func (o ShowQueueTagsResponse) String() string

type ShowQuotasRequest

type ShowQuotasRequest struct {
}

Request Object

func (ShowQuotasRequest) String

func (o ShowQuotasRequest) String() string

type ShowQuotasRespQuotas

type ShowQuotasRespQuotas struct {

	// 配额列表。
	Resources *[]ShowQuotasRespQuotasResources `json:"resources,omitempty"`
}

配额信息。

func (ShowQuotasRespQuotas) String

func (o ShowQuotasRespQuotas) String() string

type ShowQuotasRespQuotasResources

type ShowQuotasRespQuotasResources struct {

	// 配额名称。
	Type *string `json:"type,omitempty"`

	// 配额数量。
	Quota *int32 `json:"quota,omitempty"`

	// 已使用的数量。
	Used *int32 `json:"used,omitempty"`

	// 配额调整的最小值。
	Min *int32 `json:"min,omitempty"`

	// 配额调整的最大值。
	Max *int32 `json:"max,omitempty"`
}

func (ShowQuotasRespQuotasResources) String

type ShowQuotasResponse

type ShowQuotasResponse struct {
	Quotas         *ShowQuotasRespQuotas `json:"quotas,omitempty"`
	HttpStatusCode int                   `json:"-"`
}

Response Object

func (ShowQuotasResponse) String

func (o ShowQuotasResponse) String() string

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL