apis

package
v1.62.0 Latest Latest
Warning

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

 Go to latest Published: Aug 16, 2023 License: Apache-2.0 Imports: 2 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddTopicRequest 

type AddTopicRequest struct {
	core.JDCloudRequest

	/* 地域ID  */
	RegionId string `json:"regionId"`

	/* 示例：{"topicModel":{"topic":{"archived":0,"id":"","name":"create","remark":"备注","shardNum":1,"partitionNum":2,"lifecycle":3}}}  */
	TopicModel *streambus.TopicModel `json:"topicModel"`
}

func NewAddTopicRequest 

func NewAddTopicRequest(
	regionId string,
	topicModel *streambus.TopicModel,
) *AddTopicRequest

* param regionId: 地域ID (Required) * param topicModel: 示例：{"topicModel":{"topic":{"archived":0,"id":"","name":"create","remark":"备注","shardNum":1,"partitionNum":2,"lifecycle":3}}} (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewAddTopicRequestWithAllParams added in v1.0.5 

func NewAddTopicRequestWithAllParams(
	regionId string,
	topicModel *streambus.TopicModel,
) *AddTopicRequest

* param regionId: 地域ID (Required) * param topicModel: 示例：{"topicModel":{"topic":{"archived":0,"id":"","name":"create","remark":"备注","shardNum":1,"partitionNum":2,"lifecycle":3}}} (Required)

func NewAddTopicRequestWithoutParam added in v1.0.5 

func NewAddTopicRequestWithoutParam() *AddTopicRequest

This constructor has better compatible ability when API parameters changed

func (AddTopicRequest) GetRegionId 

func (r AddTopicRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*AddTopicRequest) SetRegionId 

func (r *AddTopicRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

func (*AddTopicRequest) SetTopicModel 

func (r *AddTopicRequest) SetTopicModel(topicModel *streambus.TopicModel)

param topicModel: 示例：{"topicModel":{"topic":{"archived":0,"id":"","name":"create","remark":"备注","shardNum":1,"partitionNum":2,"lifecycle":3}}}(Required)

type AddTopicResponse 

type AddTopicResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    AddTopicResult     `json:"result"`
}

type AddTopicResult 

type AddTopicResult struct {
	Status  bool   `json:"status"`
	Message string `json:"message"`
}

type CreateConsumerGroupRequest added in v1.0.5 

type CreateConsumerGroupRequest struct {
	core.JDCloudRequest

	/* Region ID  */
	RegionId string `json:"regionId"`

	/* 消费组对象 (Optional) */
	ConsumerGroupStr *streambus.ConsumerGroup `json:"consumerGroupStr"`
}

func NewCreateConsumerGroupRequest added in v1.0.5 

func NewCreateConsumerGroupRequest(
	regionId string,
) *CreateConsumerGroupRequest

* param regionId: Region ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewCreateConsumerGroupRequestWithAllParams added in v1.0.5 

func NewCreateConsumerGroupRequestWithAllParams(
	regionId string,
	consumerGroupStr *streambus.ConsumerGroup,
) *CreateConsumerGroupRequest

* param regionId: Region ID (Required) * param consumerGroupStr: 消费组对象 (Optional)

func NewCreateConsumerGroupRequestWithoutParam added in v1.0.5 

func NewCreateConsumerGroupRequestWithoutParam() *CreateConsumerGroupRequest

This constructor has better compatible ability when API parameters changed

func (CreateConsumerGroupRequest) GetRegionId added in v1.0.5 

func (r CreateConsumerGroupRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*CreateConsumerGroupRequest) SetConsumerGroupStr added in v1.0.5 

func (r *CreateConsumerGroupRequest) SetConsumerGroupStr(consumerGroupStr *streambus.ConsumerGroup)

param consumerGroupStr: 消费组对象(Optional)

func (*CreateConsumerGroupRequest) SetRegionId added in v1.0.5 

func (r *CreateConsumerGroupRequest) SetRegionId(regionId string)

param regionId: Region ID(Required)

type CreateConsumerGroupResponse added in v1.0.5 

type CreateConsumerGroupResponse struct {
	RequestID string                    `json:"requestId"`
	Error     core.ErrorResponse        `json:"error"`
	Result    CreateConsumerGroupResult `json:"result"`
}

type CreateConsumerGroupResult added in v1.0.5 

type CreateConsumerGroupResult struct {
	Message string `json:"message"`
	Status  bool   `json:"status"`
}

type DeleteConsumerGroupRequest added in v1.0.5 

type DeleteConsumerGroupRequest struct {
	core.JDCloudRequest

	/* Region ID  */
	RegionId string `json:"regionId"`

	/* 主题ID  */
	TopicId int `json:"topicId"`

	/* 消费组ID  */
	ConsumerGroupId int `json:"consumerGroupId"`
}

func NewDeleteConsumerGroupRequest added in v1.0.5 

func NewDeleteConsumerGroupRequest(
	regionId string,
	topicId int,
	consumerGroupId int,
) *DeleteConsumerGroupRequest

* param regionId: Region ID (Required) * param topicId: 主题ID (Required) * param consumerGroupId: 消费组ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDeleteConsumerGroupRequestWithAllParams added in v1.0.5 

func NewDeleteConsumerGroupRequestWithAllParams(
	regionId string,
	topicId int,
	consumerGroupId int,
) *DeleteConsumerGroupRequest

* param regionId: Region ID (Required) * param topicId: 主题ID (Required) * param consumerGroupId: 消费组ID (Required)

func NewDeleteConsumerGroupRequestWithoutParam added in v1.0.5 

func NewDeleteConsumerGroupRequestWithoutParam() *DeleteConsumerGroupRequest

This constructor has better compatible ability when API parameters changed

func (DeleteConsumerGroupRequest) GetRegionId added in v1.0.5 

func (r DeleteConsumerGroupRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DeleteConsumerGroupRequest) SetConsumerGroupId added in v1.0.5 

func (r *DeleteConsumerGroupRequest) SetConsumerGroupId(consumerGroupId int)

param consumerGroupId: 消费组ID(Required)

func (*DeleteConsumerGroupRequest) SetRegionId added in v1.0.5 

func (r *DeleteConsumerGroupRequest) SetRegionId(regionId string)

param regionId: Region ID(Required)

func (*DeleteConsumerGroupRequest) SetTopicId added in v1.0.5 

func (r *DeleteConsumerGroupRequest) SetTopicId(topicId int)

param topicId: 主题ID(Required)

type DeleteConsumerGroupResponse added in v1.0.5 

type DeleteConsumerGroupResponse struct {
	RequestID string                    `json:"requestId"`
	Error     core.ErrorResponse        `json:"error"`
	Result    DeleteConsumerGroupResult `json:"result"`
}

type DeleteConsumerGroupResult added in v1.0.5 

type DeleteConsumerGroupResult struct {
	Message string `json:"message"`
	Status  bool   `json:"status"`
}

type DeleteTopicRequest added in v1.0.5 

type DeleteTopicRequest struct {
	core.JDCloudRequest

	/* 地域ID  */
	RegionId string `json:"regionId"`

	/*   */
	Name string `json:"name"`
}

func NewDeleteTopicRequest added in v1.0.5 

func NewDeleteTopicRequest(
	regionId string,
	name string,
) *DeleteTopicRequest

* param regionId: 地域ID (Required) * param name: (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDeleteTopicRequestWithAllParams added in v1.0.5 

func NewDeleteTopicRequestWithAllParams(
	regionId string,
	name string,
) *DeleteTopicRequest

* param regionId: 地域ID (Required) * param name: (Required)

func NewDeleteTopicRequestWithoutParam added in v1.0.5 

func NewDeleteTopicRequestWithoutParam() *DeleteTopicRequest

This constructor has better compatible ability when API parameters changed

func (DeleteTopicRequest) GetRegionId added in v1.0.5 

func (r DeleteTopicRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DeleteTopicRequest) SetName added in v1.0.5 

func (r *DeleteTopicRequest) SetName(name string)

param name: (Required)

func (*DeleteTopicRequest) SetRegionId added in v1.0.5 

func (r *DeleteTopicRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

type DeleteTopicResponse added in v1.0.5 

type DeleteTopicResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    DeleteTopicResult  `json:"result"`
}

type DeleteTopicResult added in v1.0.5 

type DeleteTopicResult struct {
	Status  bool   `json:"status"`
	Message string `json:"message"`
}

type DescribeTopicRequest added in v1.0.5 

type DescribeTopicRequest struct {
	core.JDCloudRequest

	/* 地域ID  */
	RegionId string `json:"regionId"`

	/*   */
	Name string `json:"name"`
}

func NewDescribeTopicRequest added in v1.0.5 

func NewDescribeTopicRequest(
	regionId string,
	name string,
) *DescribeTopicRequest

* param regionId: 地域ID (Required) * param name: (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDescribeTopicRequestWithAllParams added in v1.0.5 

func NewDescribeTopicRequestWithAllParams(
	regionId string,
	name string,
) *DescribeTopicRequest

* param regionId: 地域ID (Required) * param name: (Required)

func NewDescribeTopicRequestWithoutParam added in v1.0.5 

func NewDescribeTopicRequestWithoutParam() *DescribeTopicRequest

This constructor has better compatible ability when API parameters changed

func (DescribeTopicRequest) GetRegionId added in v1.0.5 

func (r DescribeTopicRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DescribeTopicRequest) SetName added in v1.0.5 

func (r *DescribeTopicRequest) SetName(name string)

param name: (Required)

func (*DescribeTopicRequest) SetRegionId added in v1.0.5 

func (r *DescribeTopicRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

type DescribeTopicResponse added in v1.0.5 

type DescribeTopicResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    DescribeTopicResult `json:"result"`
}

type DescribeTopicResult added in v1.0.5 

type DescribeTopicResult struct {
	Topic streambus.TopicModel `json:"topic"`
}

type GetConsumerGroupListRequest added in v1.0.5 

type GetConsumerGroupListRequest struct {
	core.JDCloudRequest

	/* Region ID  */
	RegionId string `json:"regionId"`

	/* 主题id  */
	TopicId int `json:"topicId"`
}

func NewGetConsumerGroupListRequest added in v1.0.5 

func NewGetConsumerGroupListRequest(
	regionId string,
	topicId int,
) *GetConsumerGroupListRequest

* param regionId: Region ID (Required) * param topicId: 主题id (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewGetConsumerGroupListRequestWithAllParams added in v1.0.5 

func NewGetConsumerGroupListRequestWithAllParams(
	regionId string,
	topicId int,
) *GetConsumerGroupListRequest

* param regionId: Region ID (Required) * param topicId: 主题id (Required)

func NewGetConsumerGroupListRequestWithoutParam added in v1.0.5 

func NewGetConsumerGroupListRequestWithoutParam() *GetConsumerGroupListRequest

This constructor has better compatible ability when API parameters changed

func (GetConsumerGroupListRequest) GetRegionId added in v1.0.5 

func (r GetConsumerGroupListRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*GetConsumerGroupListRequest) SetRegionId added in v1.0.5 

func (r *GetConsumerGroupListRequest) SetRegionId(regionId string)

param regionId: Region ID(Required)

func (*GetConsumerGroupListRequest) SetTopicId added in v1.0.5 

func (r *GetConsumerGroupListRequest) SetTopicId(topicId int)

param topicId: 主题id(Required)

type GetConsumerGroupListResponse added in v1.0.5 

type GetConsumerGroupListResponse struct {
	RequestID string                     `json:"requestId"`
	Error     core.ErrorResponse         `json:"error"`
	Result    GetConsumerGroupListResult `json:"result"`
}

type GetConsumerGroupListResult added in v1.0.5 

type GetConsumerGroupListResult struct {
	ConsumerGroup []streambus.ConsumerGroup `json:"consumerGroup"`
}

type GetTopicListRequest 

type GetTopicListRequest struct {
	core.JDCloudRequest

	/* 地域ID  */
	RegionId string `json:"regionId"`

	/*  (Optional) */
	Keyword *string `json:"keyword"`
}

func NewGetTopicListRequest 

func NewGetTopicListRequest(
	regionId string,
) *GetTopicListRequest

* param regionId: 地域ID (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewGetTopicListRequestWithAllParams added in v1.0.5 

func NewGetTopicListRequestWithAllParams(
	regionId string,
	keyword *string,
) *GetTopicListRequest

* param regionId: 地域ID (Required) * param keyword: (Optional)

func NewGetTopicListRequestWithoutParam added in v1.0.5 

func NewGetTopicListRequestWithoutParam() *GetTopicListRequest

This constructor has better compatible ability when API parameters changed

func (GetTopicListRequest) GetRegionId 

func (r GetTopicListRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*GetTopicListRequest) SetKeyword 

func (r *GetTopicListRequest) SetKeyword(keyword string)

param keyword: (Optional)

func (*GetTopicListRequest) SetRegionId 

func (r *GetTopicListRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

type GetTopicListResponse 

type GetTopicListResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    GetTopicListResult `json:"result"`
}

type GetTopicListResult 

type GetTopicListResult struct {
	Topic []streambus.TopicListInfo `json:"topic"`
}

type UpdateTopicRequest 

type UpdateTopicRequest struct {
	core.JDCloudRequest

	/* 地域ID  */
	RegionId string `json:"regionId"`

	/* 当更新主题时只需要修改topicModel中的topic中的属性即可；创建归档需要指定target以及归档的目的地(mysql,京东云 Elasticsearch,对象存储,数据计算服务)参数  */
	TopicModel *streambus.TopicModel `json:"topicModel"`
}

func NewUpdateTopicRequest 

func NewUpdateTopicRequest(
	regionId string,
	topicModel *streambus.TopicModel,
) *UpdateTopicRequest

* param regionId: 地域ID (Required) * param topicModel: 当更新主题时只需要修改topicModel中的topic中的属性即可；创建归档需要指定target以及归档的目的地(mysql,京东云 Elasticsearch,对象存储,数据计算服务)参数 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewUpdateTopicRequestWithAllParams added in v1.0.5 

func NewUpdateTopicRequestWithAllParams(
	regionId string,
	topicModel *streambus.TopicModel,
) *UpdateTopicRequest

* param regionId: 地域ID (Required) * param topicModel: 当更新主题时只需要修改topicModel中的topic中的属性即可；创建归档需要指定target以及归档的目的地(mysql,京东云 Elasticsearch,对象存储,数据计算服务)参数 (Required)

func NewUpdateTopicRequestWithoutParam added in v1.0.5 

func NewUpdateTopicRequestWithoutParam() *UpdateTopicRequest

This constructor has better compatible ability when API parameters changed

func (UpdateTopicRequest) GetRegionId 

func (r UpdateTopicRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*UpdateTopicRequest) SetRegionId 

func (r *UpdateTopicRequest) SetRegionId(regionId string)

param regionId: 地域ID(Required)

func (*UpdateTopicRequest) SetTopicModel 

func (r *UpdateTopicRequest) SetTopicModel(topicModel *streambus.TopicModel)

param topicModel: 当更新主题时只需要修改topicModel中的topic中的属性即可；创建归档需要指定target以及归档的目的地(mysql,京东云 Elasticsearch,对象存储,数据计算服务)参数(Required)

type UpdateTopicResponse 

type UpdateTopicResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    UpdateTopicResult  `json:"result"`
}

type UpdateTopicResult 

type UpdateTopicResult struct {
	Status  bool   `json:"status"`
	Message string `json:"message"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.