urocketmq

Documentation

Overview

Package urocketmq include resources of ucloud urocketmq product

See also

• API: https://docs.ucloud.cn/api/urocketmq-api/index
• Product: https://www.ucloud.cn/site/product/urocketmq.html

for detail.

Index

• type CreateURocketMQGroupRequest
• type CreateURocketMQGroupResponse
• type DeleteURocketMQGroupRequest
• type DeleteURocketMQGroupResponse
• type GroupBaseInfo
• type ListURocketMQGroupRequest
• type ListURocketMQGroupResponse
• type URocketMQClient
  • func NewClient(config *ucloud.Config, credential *auth.Credential) *URocketMQClient
  • func (c *URocketMQClient) CreateURocketMQGroup(req *CreateURocketMQGroupRequest) (*CreateURocketMQGroupResponse, error)
  • func (c *URocketMQClient) DeleteURocketMQGroup(req *DeleteURocketMQGroupRequest) (*DeleteURocketMQGroupResponse, error)
  • func (c *URocketMQClient) ListURocketMQGroup(req *ListURocketMQGroupRequest) (*ListURocketMQGroupResponse, error)
  • func (c *URocketMQClient) NewCreateURocketMQGroupRequest() *CreateURocketMQGroupRequest
  • func (c *URocketMQClient) NewDeleteURocketMQGroupRequest() *DeleteURocketMQGroupRequest
  • func (c *URocketMQClient) NewListURocketMQGroupRequest() *ListURocketMQGroupRequest

Types

type CreateURocketMQGroupRequest

type CreateURocketMQGroupRequest struct {
	request.CommonBase

	// Group 名称，支持大小写字母、数字及-, _ ，长度1~36
	Name *string `required:"true"`

	// Group 描述.
	Remark *string `required:"false"`

	// Service ID
	ServiceId *string `required:"true"`
}

CreateURocketMQGroupRequest is request schema for CreateURocketMQGroup action

type CreateURocketMQGroupResponse

type CreateURocketMQGroupResponse struct {
	response.CommonBase

	// 新建 Group 的 ID
	GroupId string

	// 返回信息
	Message string
}

CreateURocketMQGroupResponse is response schema for CreateURocketMQGroup action

type DeleteURocketMQGroupRequest

type DeleteURocketMQGroupRequest struct {
	request.CommonBase

	// Group名称
	GroupName *string `required:"true"`

	// Service ID
	ServiceId *string `required:"true"`
}

DeleteURocketMQGroupRequest is request schema for DeleteURocketMQGroup action

type DeleteURocketMQGroupResponse

type DeleteURocketMQGroupResponse struct {
	response.CommonBase

	// 返回信息
	Message string
}

DeleteURocketMQGroupResponse is response schema for DeleteURocketMQGroup action

type GroupBaseInfo

type GroupBaseInfo struct {

	// Group 创建时间
	CreateTime int

	// Group 名称
	GroupName string

	// Group ID
	Id string

	// Group 描述
	Remark string
}

GroupBaseInfo - Group基础信息

type ListURocketMQGroupRequest

type ListURocketMQGroupRequest struct {
	request.CommonBase

	// 最多返回的条目数量, (0, 1000], 默认 50 条
	Limit *int `required:"false"`

	// 查询起始位置, [0, ∞)
	Offset *int `required:"false"`

	// Service ID
	ServiceId *string `required:"true"`
}

ListURocketMQGroupRequest is request schema for ListURocketMQGroup action

type ListURocketMQGroupResponse

type ListURocketMQGroupResponse struct {
	response.CommonBase

	// Group列表信息
	GroupList []GroupBaseInfo

	// 返回信息
	Message string

	// 记录总数
	TotalCount int
}

ListURocketMQGroupResponse is response schema for ListURocketMQGroup action

type URocketMQClient

type URocketMQClient struct {
	*ucloud.Client
}

URocketMQClient is the client of URocketMQ

func NewClient

func NewClient(config *ucloud.Config, credential *auth.Credential) *URocketMQClient

NewClient will return a instance of URocketMQClient

func (*URocketMQClient) CreateURocketMQGroup

func (c *URocketMQClient) CreateURocketMQGroup(req *CreateURocketMQGroupRequest) (*CreateURocketMQGroupResponse, error)

API: CreateURocketMQGroup

创建一个 Group, 如果同名 Group 在当前 Service 中已存在, 则会失败.

func (*URocketMQClient) DeleteURocketMQGroup

func (c *URocketMQClient) DeleteURocketMQGroup(req *DeleteURocketMQGroupRequest) (*DeleteURocketMQGroupResponse, error)

API: DeleteURocketMQGroup

删除一个已存在的 Group

func (*URocketMQClient) ListURocketMQGroup

func (c *URocketMQClient) ListURocketMQGroup(req *ListURocketMQGroupRequest) (*ListURocketMQGroupResponse, error)

API: ListURocketMQGroup

获取一个 RocketMQ 服务下的所有 Group

func (*URocketMQClient) NewCreateURocketMQGroupRequest

func (c *URocketMQClient) NewCreateURocketMQGroupRequest() *CreateURocketMQGroupRequest

NewCreateURocketMQGroupRequest will create request of CreateURocketMQGroup action.

func (*URocketMQClient) NewDeleteURocketMQGroupRequest

func (c *URocketMQClient) NewDeleteURocketMQGroupRequest() *DeleteURocketMQGroupRequest

NewDeleteURocketMQGroupRequest will create request of DeleteURocketMQGroup action.

func (*URocketMQClient) NewListURocketMQGroupRequest

func (c *URocketMQClient) NewListURocketMQGroupRequest() *ListURocketMQGroupRequest

NewListURocketMQGroupRequest will create request of ListURocketMQGroup action.