adminrestv1

package
v1.4.1 Latest Latest
Warning

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

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

Documentation

Overview

Package adminrestv1 : Operations and models for the AdminrestV1 service

Index

Constants

View Source 
const DefaultServiceName = "adminrest"

DefaultServiceName is the default key used to find external configuration information.

Variables

This section is empty.

Functions

func GetServiceURLForRegion 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalBrokerDetail added in v1.4.1 

func UnmarshalBrokerDetail(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBrokerDetail unmarshals an instance of BrokerDetail from the specified map of raw messages.

func UnmarshalBrokerDetailConfigsItem added in v1.4.1 

func UnmarshalBrokerDetailConfigsItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBrokerDetailConfigsItem unmarshals an instance of BrokerDetailConfigsItem from the specified map of raw messages.

func UnmarshalBrokerSummary added in v1.4.1 

func UnmarshalBrokerSummary(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBrokerSummary unmarshals an instance of BrokerSummary from the specified map of raw messages.

func UnmarshalCluster added in v1.4.1 

func UnmarshalCluster(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCluster unmarshals an instance of Cluster from the specified map of raw messages.

func UnmarshalEntityQuotaDetail added in v1.3.0 

func UnmarshalEntityQuotaDetail(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalEntityQuotaDetail unmarshals an instance of EntityQuotaDetail from the specified map of raw messages.

func UnmarshalGroupDetail added in v1.4.1 

func UnmarshalGroupDetail(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupDetail unmarshals an instance of GroupDetail from the specified map of raw messages.

func UnmarshalGroupResetResultsItem added in v1.4.1 

func UnmarshalGroupResetResultsItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupResetResultsItem unmarshals an instance of GroupResetResultsItem from the specified map of raw messages.

func UnmarshalMember added in v1.4.1 

func UnmarshalMember(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMember unmarshals an instance of Member from the specified map of raw messages.

func UnmarshalMemberAssignmentsItem added in v1.4.1 

func UnmarshalMemberAssignmentsItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMemberAssignmentsItem unmarshals an instance of MemberAssignmentsItem from the specified map of raw messages.

func UnmarshalMirroringActiveTopics 

func UnmarshalMirroringActiveTopics(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMirroringActiveTopics unmarshals an instance of MirroringActiveTopics from the specified map of raw messages.

func UnmarshalMirroringTopicSelection 

func UnmarshalMirroringTopicSelection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMirroringTopicSelection unmarshals an instance of MirroringTopicSelection from the specified map of raw messages.

func UnmarshalQuotaDetail added in v1.3.0 

func UnmarshalQuotaDetail(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalQuotaDetail unmarshals an instance of QuotaDetail from the specified map of raw messages.

func UnmarshalQuotaList added in v1.4.1 

func UnmarshalQuotaList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalQuotaList unmarshals an instance of QuotaList from the specified map of raw messages.

func UnmarshalRecordDeleteRequestRecordsToDeleteItem added in v1.4.1 

func UnmarshalRecordDeleteRequestRecordsToDeleteItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRecordDeleteRequestRecordsToDeleteItem unmarshals an instance of RecordDeleteRequestRecordsToDeleteItem from the specified map of raw messages.

func UnmarshalTopicConfigs 

func UnmarshalTopicConfigs(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTopicConfigs unmarshals an instance of TopicConfigs from the specified map of raw messages.

func UnmarshalTopicCreateRequestConfigsItem added in v1.4.1 

func UnmarshalTopicCreateRequestConfigsItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTopicCreateRequestConfigsItem unmarshals an instance of TopicCreateRequestConfigsItem from the specified map of raw messages.

func UnmarshalTopicDetail 

func UnmarshalTopicDetail(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTopicDetail unmarshals an instance of TopicDetail from the specified map of raw messages.

func UnmarshalTopicDetailReplicaAssignmentsItem added in v1.4.1 

func UnmarshalTopicDetailReplicaAssignmentsItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTopicDetailReplicaAssignmentsItem unmarshals an instance of TopicDetailReplicaAssignmentsItem from the specified map of raw messages.

func UnmarshalTopicDetailReplicaAssignmentsItemBrokers added in v1.4.1 

func UnmarshalTopicDetailReplicaAssignmentsItemBrokers(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTopicDetailReplicaAssignmentsItemBrokers unmarshals an instance of TopicDetailReplicaAssignmentsItemBrokers from the specified map of raw messages.

func UnmarshalTopicPartitionOffset added in v1.4.1 

func UnmarshalTopicPartitionOffset(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTopicPartitionOffset unmarshals an instance of TopicPartitionOffset from the specified map of raw messages.

func UnmarshalTopicUpdateRequestConfigsItem added in v1.4.1 

func UnmarshalTopicUpdateRequestConfigsItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTopicUpdateRequestConfigsItem unmarshals an instance of TopicUpdateRequestConfigsItem from the specified map of raw messages.

Types

type AdminrestV1 

type AdminrestV1 struct {
	Service *core.BaseService
}

AdminrestV1 : The administration REST API for IBM Event Streams on Cloud.

API Version: 1.3.0

func NewAdminrestV1 

func NewAdminrestV1(options *AdminrestV1Options) (service *AdminrestV1, err error)

NewAdminrestV1 : constructs an instance of AdminrestV1 with passed in options.

func NewAdminrestV1UsingExternalConfig 

func NewAdminrestV1UsingExternalConfig(options *AdminrestV1Options) (adminrest *AdminrestV1, err error)

NewAdminrestV1UsingExternalConfig : constructs an instance of AdminrestV1 with passed in options and external configuration.

func (*AdminrestV1) Alive added in v1.4.1 

func (adminrest *AdminrestV1) Alive(aliveOptions *AliveOptions) (response *core.DetailedResponse, err error)

Alive : Basic health check for Admin REST API

func (*AdminrestV1) AliveWithContext added in v1.4.1 

func (adminrest *AdminrestV1) AliveWithContext(ctx context.Context, aliveOptions *AliveOptions) (response *core.DetailedResponse, err error)

AliveWithContext is an alternate form of the Alive method which supports a Context parameter

func (*AdminrestV1) Clone 

func (adminrest *AdminrestV1) Clone() *AdminrestV1

Clone makes a copy of "adminrest" suitable for processing requests.

func (*AdminrestV1) CreateQuota added in v1.3.0 

func (adminrest *AdminrestV1) CreateQuota(createQuotaOptions *CreateQuotaOptions) (response *core.DetailedResponse, err error)

CreateQuota : Create a new quota Create a new quota.

func (*AdminrestV1) CreateQuotaWithContext added in v1.3.0 

func (adminrest *AdminrestV1) CreateQuotaWithContext(ctx context.Context, createQuotaOptions *CreateQuotaOptions) (response *core.DetailedResponse, err error)

CreateQuotaWithContext is an alternate form of the CreateQuota method which supports a Context parameter

func (*AdminrestV1) CreateTopic 

func (adminrest *AdminrestV1) CreateTopic(createTopicOptions *CreateTopicOptions) (response *core.DetailedResponse, err error)

CreateTopic : Create a new topic Create a new topic.

func (*AdminrestV1) CreateTopicWithContext 

func (adminrest *AdminrestV1) CreateTopicWithContext(ctx context.Context, createTopicOptions *CreateTopicOptions) (response *core.DetailedResponse, err error)

CreateTopicWithContext is an alternate form of the CreateTopic method which supports a Context parameter

func (*AdminrestV1) DeleteConsumerGroup added in v1.4.1 

func (adminrest *AdminrestV1) DeleteConsumerGroup(deleteConsumerGroupOptions *DeleteConsumerGroupOptions) (response *core.DetailedResponse, err error)

DeleteConsumerGroup : Delete a consumer group Delete a consumer group.

func (*AdminrestV1) DeleteConsumerGroupWithContext added in v1.4.1 

func (adminrest *AdminrestV1) DeleteConsumerGroupWithContext(ctx context.Context, deleteConsumerGroupOptions *DeleteConsumerGroupOptions) (response *core.DetailedResponse, err error)

DeleteConsumerGroupWithContext is an alternate form of the DeleteConsumerGroup method which supports a Context parameter

func (*AdminrestV1) DeleteQuota added in v1.3.0 

func (adminrest *AdminrestV1) DeleteQuota(deleteQuotaOptions *DeleteQuotaOptions) (response *core.DetailedResponse, err error)

DeleteQuota : Delete a quota Delete an entity's quota.

func (*AdminrestV1) DeleteQuotaWithContext added in v1.3.0 

func (adminrest *AdminrestV1) DeleteQuotaWithContext(ctx context.Context, deleteQuotaOptions *DeleteQuotaOptions) (response *core.DetailedResponse, err error)

DeleteQuotaWithContext is an alternate form of the DeleteQuota method which supports a Context parameter

func (*AdminrestV1) DeleteTopic 

func (adminrest *AdminrestV1) DeleteTopic(deleteTopicOptions *DeleteTopicOptions) (response *core.DetailedResponse, err error)

DeleteTopic : Delete a topic Delete a topic.

func (*AdminrestV1) DeleteTopicRecords added in v1.4.1 

func (adminrest *AdminrestV1) DeleteTopicRecords(deleteTopicRecordsOptions *DeleteTopicRecordsOptions) (response *core.DetailedResponse, err error)

DeleteTopicRecords : Delete records before the given offset on a topic Delete records before the given offset on a topic.

func (*AdminrestV1) DeleteTopicRecordsWithContext added in v1.4.1 

func (adminrest *AdminrestV1) DeleteTopicRecordsWithContext(ctx context.Context, deleteTopicRecordsOptions *DeleteTopicRecordsOptions) (response *core.DetailedResponse, err error)

DeleteTopicRecordsWithContext is an alternate form of the DeleteTopicRecords method which supports a Context parameter

func (*AdminrestV1) DeleteTopicWithContext 

func (adminrest *AdminrestV1) DeleteTopicWithContext(ctx context.Context, deleteTopicOptions *DeleteTopicOptions) (response *core.DetailedResponse, err error)

DeleteTopicWithContext is an alternate form of the DeleteTopic method which supports a Context parameter

func (*AdminrestV1) DisableRetries 

func (adminrest *AdminrestV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*AdminrestV1) EnableRetries 

func (adminrest *AdminrestV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*AdminrestV1) GetBroker added in v1.4.1 

func (adminrest *AdminrestV1) GetBroker(getBrokerOptions *GetBrokerOptions) (result *BrokerDetail, response *core.DetailedResponse, err error)

GetBroker : Get detailed information for a single broker Get detailed information for a single broker.

func (*AdminrestV1) GetBrokerConfig added in v1.4.1 

func (adminrest *AdminrestV1) GetBrokerConfig(getBrokerConfigOptions *GetBrokerConfigOptions) (result *BrokerDetail, response *core.DetailedResponse, err error)

GetBrokerConfig : Get all configuration parameters for a single broker Get all configuration parameters for a single broker.

func (*AdminrestV1) GetBrokerConfigWithContext added in v1.4.1 

func (adminrest *AdminrestV1) GetBrokerConfigWithContext(ctx context.Context, getBrokerConfigOptions *GetBrokerConfigOptions) (result *BrokerDetail, response *core.DetailedResponse, err error)

GetBrokerConfigWithContext is an alternate form of the GetBrokerConfig method which supports a Context parameter

func (*AdminrestV1) GetBrokerWithContext added in v1.4.1 

func (adminrest *AdminrestV1) GetBrokerWithContext(ctx context.Context, getBrokerOptions *GetBrokerOptions) (result *BrokerDetail, response *core.DetailedResponse, err error)

GetBrokerWithContext is an alternate form of the GetBroker method which supports a Context parameter

func (*AdminrestV1) GetCluster added in v1.4.1 

func (adminrest *AdminrestV1) GetCluster(getClusterOptions *GetClusterOptions) (result *Cluster, response *core.DetailedResponse, err error)

GetCluster : Get information about the cluster Get information about the cluster.

func (*AdminrestV1) GetClusterWithContext added in v1.4.1 

func (adminrest *AdminrestV1) GetClusterWithContext(ctx context.Context, getClusterOptions *GetClusterOptions) (result *Cluster, response *core.DetailedResponse, err error)

GetClusterWithContext is an alternate form of the GetCluster method which supports a Context parameter

func (*AdminrestV1) GetConsumerGroup added in v1.4.1 

func (adminrest *AdminrestV1) GetConsumerGroup(getConsumerGroupOptions *GetConsumerGroupOptions) (result *GroupDetail, response *core.DetailedResponse, err error)

GetConsumerGroup : Get detailed information on a consumer group Get detailed information on a consumer group.

func (*AdminrestV1) GetConsumerGroupWithContext added in v1.4.1 

func (adminrest *AdminrestV1) GetConsumerGroupWithContext(ctx context.Context, getConsumerGroupOptions *GetConsumerGroupOptions) (result *GroupDetail, response *core.DetailedResponse, err error)

GetConsumerGroupWithContext is an alternate form of the GetConsumerGroup method which supports a Context parameter

func (*AdminrestV1) GetEnableGzipCompression 

func (adminrest *AdminrestV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*AdminrestV1) GetMirroringActiveTopics 

func (adminrest *AdminrestV1) GetMirroringActiveTopics(getMirroringActiveTopicsOptions *GetMirroringActiveTopicsOptions) (result *MirroringActiveTopics, response *core.DetailedResponse, err error)

GetMirroringActiveTopics : Get topics that are being actively mirrored Get topics that are being actively mirrored.

func (*AdminrestV1) GetMirroringActiveTopicsWithContext 

func (adminrest *AdminrestV1) GetMirroringActiveTopicsWithContext(ctx context.Context, getMirroringActiveTopicsOptions *GetMirroringActiveTopicsOptions) (result *MirroringActiveTopics, response *core.DetailedResponse, err error)

GetMirroringActiveTopicsWithContext is an alternate form of the GetMirroringActiveTopics method which supports a Context parameter

func (*AdminrestV1) GetMirroringTopicSelection 

func (adminrest *AdminrestV1) GetMirroringTopicSelection(getMirroringTopicSelectionOptions *GetMirroringTopicSelectionOptions) (result *MirroringTopicSelection, response *core.DetailedResponse, err error)

GetMirroringTopicSelection : Get current topic selection for mirroring Get current topic selection for mirroring.

func (*AdminrestV1) GetMirroringTopicSelectionWithContext 

func (adminrest *AdminrestV1) GetMirroringTopicSelectionWithContext(ctx context.Context, getMirroringTopicSelectionOptions *GetMirroringTopicSelectionOptions) (result *MirroringTopicSelection, response *core.DetailedResponse, err error)

GetMirroringTopicSelectionWithContext is an alternate form of the GetMirroringTopicSelection method which supports a Context parameter

func (*AdminrestV1) GetQuota added in v1.3.0 

func (adminrest *AdminrestV1) GetQuota(getQuotaOptions *GetQuotaOptions) (result *QuotaDetail, response *core.DetailedResponse, err error)

GetQuota : Get quota information for an entity Get quota information for an entity.

func (*AdminrestV1) GetQuotaWithContext added in v1.3.0 

func (adminrest *AdminrestV1) GetQuotaWithContext(ctx context.Context, getQuotaOptions *GetQuotaOptions) (result *QuotaDetail, response *core.DetailedResponse, err error)

GetQuotaWithContext is an alternate form of the GetQuota method which supports a Context parameter

func (*AdminrestV1) GetServiceURL 

func (adminrest *AdminrestV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*AdminrestV1) GetTopic 

func (adminrest *AdminrestV1) GetTopic(getTopicOptions *GetTopicOptions) (result *TopicDetail, response *core.DetailedResponse, err error)

GetTopic : Get detailed information on a topic Get detailed information on a topic.

func (*AdminrestV1) GetTopicWithContext 

func (adminrest *AdminrestV1) GetTopicWithContext(ctx context.Context, getTopicOptions *GetTopicOptions) (result *TopicDetail, response *core.DetailedResponse, err error)

GetTopicWithContext is an alternate form of the GetTopic method which supports a Context parameter

func (*AdminrestV1) ListBrokers added in v1.4.1 

func (adminrest *AdminrestV1) ListBrokers(listBrokersOptions *ListBrokersOptions) (result []BrokerSummary, response *core.DetailedResponse, err error)

ListBrokers : Get a list of brokers in the cluster Get a list of brokers in the cluster.

func (*AdminrestV1) ListBrokersWithContext added in v1.4.1 

func (adminrest *AdminrestV1) ListBrokersWithContext(ctx context.Context, listBrokersOptions *ListBrokersOptions) (result []BrokerSummary, response *core.DetailedResponse, err error)

ListBrokersWithContext is an alternate form of the ListBrokers method which supports a Context parameter

func (*AdminrestV1) ListConsumerGroups added in v1.4.1 

func (adminrest *AdminrestV1) ListConsumerGroups(listConsumerGroupsOptions *ListConsumerGroupsOptions) (result []string, response *core.DetailedResponse, err error)

ListConsumerGroups : Get a list of consumer group IDs Get a list of consumer group IDs.

func (*AdminrestV1) ListConsumerGroupsWithContext added in v1.4.1 

func (adminrest *AdminrestV1) ListConsumerGroupsWithContext(ctx context.Context, listConsumerGroupsOptions *ListConsumerGroupsOptions) (result []string, response *core.DetailedResponse, err error)

ListConsumerGroupsWithContext is an alternate form of the ListConsumerGroups method which supports a Context parameter

func (*AdminrestV1) ListQuotas added in v1.3.0 

func (adminrest *AdminrestV1) ListQuotas(listQuotasOptions *ListQuotasOptions) (result *QuotaList, response *core.DetailedResponse, err error)

ListQuotas : List each entity's quota information List each entity's quota information.

func (*AdminrestV1) ListQuotasWithContext added in v1.3.0 

func (adminrest *AdminrestV1) ListQuotasWithContext(ctx context.Context, listQuotasOptions *ListQuotasOptions) (result *QuotaList, response *core.DetailedResponse, err error)

ListQuotasWithContext is an alternate form of the ListQuotas method which supports a Context parameter

func (*AdminrestV1) ListTopics 

func (adminrest *AdminrestV1) ListTopics(listTopicsOptions *ListTopicsOptions) (result []TopicDetail, response *core.DetailedResponse, err error)

ListTopics : Get a list of topics Returns a list containing information about all of the Kafka topics that are defined for an instance of the Event Streams service. If there are currently no topics defined then an empty list is returned.

func (*AdminrestV1) ListTopicsWithContext 

func (adminrest *AdminrestV1) ListTopicsWithContext(ctx context.Context, listTopicsOptions *ListTopicsOptions) (result []TopicDetail, response *core.DetailedResponse, err error)

ListTopicsWithContext is an alternate form of the ListTopics method which supports a Context parameter

func (*AdminrestV1) NewAliveOptions added in v1.4.1 

func (*AdminrestV1) NewAliveOptions() *AliveOptions

NewAliveOptions : Instantiate AliveOptions

func (*AdminrestV1) NewCreateQuotaOptions added in v1.3.0 

func (*AdminrestV1) NewCreateQuotaOptions(entityName string) *CreateQuotaOptions

NewCreateQuotaOptions : Instantiate CreateQuotaOptions

func (*AdminrestV1) NewCreateTopicOptions 

func (*AdminrestV1) NewCreateTopicOptions() *CreateTopicOptions

NewCreateTopicOptions : Instantiate CreateTopicOptions

func (*AdminrestV1) NewDeleteConsumerGroupOptions added in v1.4.1 

func (*AdminrestV1) NewDeleteConsumerGroupOptions(groupID string) *DeleteConsumerGroupOptions

NewDeleteConsumerGroupOptions : Instantiate DeleteConsumerGroupOptions

func (*AdminrestV1) NewDeleteQuotaOptions added in v1.3.0 

func (*AdminrestV1) NewDeleteQuotaOptions(entityName string) *DeleteQuotaOptions

NewDeleteQuotaOptions : Instantiate DeleteQuotaOptions

func (*AdminrestV1) NewDeleteTopicOptions 

func (*AdminrestV1) NewDeleteTopicOptions(topicName string) *DeleteTopicOptions

NewDeleteTopicOptions : Instantiate DeleteTopicOptions

func (*AdminrestV1) NewDeleteTopicRecordsOptions added in v1.4.1 

func (*AdminrestV1) NewDeleteTopicRecordsOptions(topicName string) *DeleteTopicRecordsOptions

NewDeleteTopicRecordsOptions : Instantiate DeleteTopicRecordsOptions

func (*AdminrestV1) NewGetBrokerConfigOptions added in v1.4.1 

func (*AdminrestV1) NewGetBrokerConfigOptions(brokerID int64) *GetBrokerConfigOptions

NewGetBrokerConfigOptions : Instantiate GetBrokerConfigOptions

func (*AdminrestV1) NewGetBrokerOptions added in v1.4.1 

func (*AdminrestV1) NewGetBrokerOptions(brokerID int64) *GetBrokerOptions

NewGetBrokerOptions : Instantiate GetBrokerOptions

func (*AdminrestV1) NewGetClusterOptions added in v1.4.1 

func (*AdminrestV1) NewGetClusterOptions() *GetClusterOptions

NewGetClusterOptions : Instantiate GetClusterOptions

func (*AdminrestV1) NewGetConsumerGroupOptions added in v1.4.1 

func (*AdminrestV1) NewGetConsumerGroupOptions(groupID string) *GetConsumerGroupOptions

NewGetConsumerGroupOptions : Instantiate GetConsumerGroupOptions

func (*AdminrestV1) NewGetMirroringActiveTopicsOptions 

func (*AdminrestV1) NewGetMirroringActiveTopicsOptions() *GetMirroringActiveTopicsOptions

NewGetMirroringActiveTopicsOptions : Instantiate GetMirroringActiveTopicsOptions

func (*AdminrestV1) NewGetMirroringTopicSelectionOptions 

func (*AdminrestV1) NewGetMirroringTopicSelectionOptions() *GetMirroringTopicSelectionOptions

NewGetMirroringTopicSelectionOptions : Instantiate GetMirroringTopicSelectionOptions

func (*AdminrestV1) NewGetQuotaOptions added in v1.3.0 

func (*AdminrestV1) NewGetQuotaOptions(entityName string) *GetQuotaOptions

NewGetQuotaOptions : Instantiate GetQuotaOptions

func (*AdminrestV1) NewGetTopicOptions 

func (*AdminrestV1) NewGetTopicOptions(topicName string) *GetTopicOptions

NewGetTopicOptions : Instantiate GetTopicOptions

func (*AdminrestV1) NewListBrokersOptions added in v1.4.1 

func (*AdminrestV1) NewListBrokersOptions() *ListBrokersOptions

NewListBrokersOptions : Instantiate ListBrokersOptions

func (*AdminrestV1) NewListConsumerGroupsOptions added in v1.4.1 

func (*AdminrestV1) NewListConsumerGroupsOptions() *ListConsumerGroupsOptions

NewListConsumerGroupsOptions : Instantiate ListConsumerGroupsOptions

func (*AdminrestV1) NewListQuotasOptions added in v1.3.0 

func (*AdminrestV1) NewListQuotasOptions() *ListQuotasOptions

NewListQuotasOptions : Instantiate ListQuotasOptions

func (*AdminrestV1) NewListTopicsOptions 

func (*AdminrestV1) NewListTopicsOptions() *ListTopicsOptions

NewListTopicsOptions : Instantiate ListTopicsOptions

func (*AdminrestV1) NewReplaceMirroringTopicSelectionOptions 

func (*AdminrestV1) NewReplaceMirroringTopicSelectionOptions() *ReplaceMirroringTopicSelectionOptions

NewReplaceMirroringTopicSelectionOptions : Instantiate ReplaceMirroringTopicSelectionOptions

func (*AdminrestV1) NewUpdateConsumerGroupOptions added in v1.4.1 

func (*AdminrestV1) NewUpdateConsumerGroupOptions(groupID string) *UpdateConsumerGroupOptions

NewUpdateConsumerGroupOptions : Instantiate UpdateConsumerGroupOptions

func (*AdminrestV1) NewUpdateQuotaOptions added in v1.3.0 

func (*AdminrestV1) NewUpdateQuotaOptions(entityName string) *UpdateQuotaOptions

NewUpdateQuotaOptions : Instantiate UpdateQuotaOptions

func (*AdminrestV1) NewUpdateTopicOptions 

func (*AdminrestV1) NewUpdateTopicOptions(topicName string) *UpdateTopicOptions

NewUpdateTopicOptions : Instantiate UpdateTopicOptions

func (*AdminrestV1) ReplaceMirroringTopicSelection 

func (adminrest *AdminrestV1) ReplaceMirroringTopicSelection(replaceMirroringTopicSelectionOptions *ReplaceMirroringTopicSelectionOptions) (result *MirroringTopicSelection, response *core.DetailedResponse, err error)

ReplaceMirroringTopicSelection : Replace topic selection for mirroring Replace topic selection for mirroring. This operation replaces the complete set of mirroring topic selections.

func (*AdminrestV1) ReplaceMirroringTopicSelectionWithContext 

func (adminrest *AdminrestV1) ReplaceMirroringTopicSelectionWithContext(ctx context.Context, replaceMirroringTopicSelectionOptions *ReplaceMirroringTopicSelectionOptions) (result *MirroringTopicSelection, response *core.DetailedResponse, err error)

ReplaceMirroringTopicSelectionWithContext is an alternate form of the ReplaceMirroringTopicSelection method which supports a Context parameter

func (*AdminrestV1) SetDefaultHeaders 

func (adminrest *AdminrestV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*AdminrestV1) SetEnableGzipCompression 

func (adminrest *AdminrestV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*AdminrestV1) SetServiceURL 

func (adminrest *AdminrestV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*AdminrestV1) UpdateConsumerGroup added in v1.4.1 

func (adminrest *AdminrestV1) UpdateConsumerGroup(updateConsumerGroupOptions *UpdateConsumerGroupOptions) (result []GroupResetResultsItem, response *core.DetailedResponse, err error)

UpdateConsumerGroup : Update the offsets of a consumer group Update the offsets of a consumer group using various modes, eg. latest, earliest, datetime,etc.

func (*AdminrestV1) UpdateConsumerGroupWithContext added in v1.4.1 

func (adminrest *AdminrestV1) UpdateConsumerGroupWithContext(ctx context.Context, updateConsumerGroupOptions *UpdateConsumerGroupOptions) (result []GroupResetResultsItem, response *core.DetailedResponse, err error)

UpdateConsumerGroupWithContext is an alternate form of the UpdateConsumerGroup method which supports a Context parameter

func (*AdminrestV1) UpdateQuota added in v1.3.0 

func (adminrest *AdminrestV1) UpdateQuota(updateQuotaOptions *UpdateQuotaOptions) (response *core.DetailedResponse, err error)

UpdateQuota : Update a quota Update an entity's quota.

func (*AdminrestV1) UpdateQuotaWithContext added in v1.3.0 

func (adminrest *AdminrestV1) UpdateQuotaWithContext(ctx context.Context, updateQuotaOptions *UpdateQuotaOptions) (response *core.DetailedResponse, err error)

UpdateQuotaWithContext is an alternate form of the UpdateQuota method which supports a Context parameter

func (*AdminrestV1) UpdateTopic 

func (adminrest *AdminrestV1) UpdateTopic(updateTopicOptions *UpdateTopicOptions) (response *core.DetailedResponse, err error)

UpdateTopic : Increase the number of partitions and/or update one or more topic configuration parameters Increase the number of partitions and/or update one or more topic configuration parameters.

func (*AdminrestV1) UpdateTopicWithContext 

func (adminrest *AdminrestV1) UpdateTopicWithContext(ctx context.Context, updateTopicOptions *UpdateTopicOptions) (response *core.DetailedResponse, err error)

UpdateTopicWithContext is an alternate form of the UpdateTopic method which supports a Context parameter

type AdminrestV1Options 

type AdminrestV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

AdminrestV1Options : Service options

type AliveOptions added in v1.4.1 

type AliveOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

AliveOptions : The Alive options.

func (*AliveOptions) SetHeaders added in v1.4.1 

func (options *AliveOptions) SetHeaders(param map[string]string) *AliveOptions

SetHeaders : Allow user to set Headers

type BrokerDetail added in v1.4.1 

type BrokerDetail struct {
	// The ID of the broker configured in the 'broker.id' broker config property.
	ID *int64 `json:"id,omitempty"`

	// The hostname that the broker is listening on and which is configured in the 'advertised.listeners' broker config
	// property.
	Host *string `json:"host,omitempty"`

	// The port that the broker is listening on and which is configured in the 'advertised.listeners' broker config
	// property.
	Port *int64 `json:"port,omitempty"`

	// The rack of the broker used in rack aware replication assignment for fault tolerance. It is configure in the
	// 'broker.rack' broker config property.
	Rack *string `json:"rack,omitempty"`

	Configs []BrokerDetailConfigsItem `json:"configs,omitempty"`
}

BrokerDetail : BrokerDetail struct

type BrokerDetailConfigsItem added in v1.4.1 

type BrokerDetailConfigsItem struct {
	// The name of the config property.
	Name *string `json:"name,omitempty"`

	// The value for a config property.
	Value *string `json:"value,omitempty"`

	// When true, the value cannot be displayed and will be returned with a null value.
	IsSensitive *bool `json:"is_sensitive,omitempty"`
}

BrokerDetailConfigsItem : BrokerDetailConfigsItem struct

type BrokerSummary added in v1.4.1 

type BrokerSummary struct {
	// The ID of the broker configured in the 'broker.id' broker config property.
	ID *int64 `json:"id,omitempty"`

	// The hostname that the broker is listening on and which is configured in the 'advertised.listeners' broker config
	// property.
	Host *string `json:"host,omitempty"`

	// The port that the broker is listening on and which is configured in the 'advertised.listeners' broker config
	// property.
	Port *int64 `json:"port,omitempty"`

	// The rack of the broker used in rack aware replication assignment for fault tolerance. It is configure in the
	// 'broker.rack' broker config property.
	Rack *string `json:"rack,omitempty"`
}

BrokerSummary : BrokerSummary struct

type Cluster added in v1.4.1 

type Cluster struct {
	// The ID of the cluster.
	ID *string `json:"id,omitempty"`

	Controller *BrokerSummary `json:"controller,omitempty"`

	// List of brokers in the cluster.
	Brokers []BrokerSummary `json:"brokers,omitempty"`
}

Cluster : Cluster struct

type CreateQuotaOptions added in v1.3.0 

type CreateQuotaOptions struct {
	// The entity name of the quotas can be `default` or an IAM Service ID that starts with an `iam-ServiceId` prefix.
	EntityName *string `json:"entity_name" validate:"required,ne="`

	// The producer byte rate quota value.
	ProducerByteRate *int64 `json:"producer_byte_rate,omitempty"`

	// The consumer byte rate quota value.
	ConsumerByteRate *int64 `json:"consumer_byte_rate,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateQuotaOptions : The CreateQuota options.

func (*CreateQuotaOptions) SetConsumerByteRate added in v1.3.0 

func (_options *CreateQuotaOptions) SetConsumerByteRate(consumerByteRate int64) *CreateQuotaOptions

SetConsumerByteRate : Allow user to set ConsumerByteRate

func (*CreateQuotaOptions) SetEntityName added in v1.3.0 

func (_options *CreateQuotaOptions) SetEntityName(entityName string) *CreateQuotaOptions

SetEntityName : Allow user to set EntityName

func (*CreateQuotaOptions) SetHeaders added in v1.3.0 

func (options *CreateQuotaOptions) SetHeaders(param map[string]string) *CreateQuotaOptions

SetHeaders : Allow user to set Headers

func (*CreateQuotaOptions) SetProducerByteRate added in v1.3.0 

func (_options *CreateQuotaOptions) SetProducerByteRate(producerByteRate int64) *CreateQuotaOptions

SetProducerByteRate : Allow user to set ProducerByteRate

type CreateTopicOptions 

type CreateTopicOptions struct {
	// The name of topic to be created.
	Name *string `json:"name,omitempty"`

	// The number of partitions.
	Partitions *int64 `json:"partitions,omitempty"`

	// The number of partitions, this field takes precedence over 'partitions'. Default value is 1 if not specified.
	PartitionCount *int64 `json:"partition_count,omitempty"`

	// The config properties to be set for the new topic.
	Configs []TopicCreateRequestConfigsItem `json:"configs,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateTopicOptions : The CreateTopic options.

func (*CreateTopicOptions) SetConfigs 

func (_options *CreateTopicOptions) SetConfigs(configs []TopicCreateRequestConfigsItem) *CreateTopicOptions

SetConfigs : Allow user to set Configs

func (*CreateTopicOptions) SetHeaders 

func (options *CreateTopicOptions) SetHeaders(param map[string]string) *CreateTopicOptions

SetHeaders : Allow user to set Headers

func (*CreateTopicOptions) SetName 

func (_options *CreateTopicOptions) SetName(name string) *CreateTopicOptions

SetName : Allow user to set Name

func (*CreateTopicOptions) SetPartitionCount 

func (_options *CreateTopicOptions) SetPartitionCount(partitionCount int64) *CreateTopicOptions

SetPartitionCount : Allow user to set PartitionCount

func (*CreateTopicOptions) SetPartitions 

func (_options *CreateTopicOptions) SetPartitions(partitions int64) *CreateTopicOptions

SetPartitions : Allow user to set Partitions

type DeleteConsumerGroupOptions added in v1.4.1 

type DeleteConsumerGroupOptions struct {
	// The group ID for the consumer group to be deleted.
	GroupID *string `json:"group_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteConsumerGroupOptions : The DeleteConsumerGroup options.

func (*DeleteConsumerGroupOptions) SetGroupID added in v1.4.1 

func (_options *DeleteConsumerGroupOptions) SetGroupID(groupID string) *DeleteConsumerGroupOptions

SetGroupID : Allow user to set GroupID

func (*DeleteConsumerGroupOptions) SetHeaders added in v1.4.1 

func (options *DeleteConsumerGroupOptions) SetHeaders(param map[string]string) *DeleteConsumerGroupOptions

SetHeaders : Allow user to set Headers

type DeleteQuotaOptions added in v1.3.0 

type DeleteQuotaOptions struct {
	// The entity name of the quotas can be `default` or an IAM Service ID that starts with an `iam-ServiceId` prefix.
	EntityName *string `json:"entity_name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteQuotaOptions : The DeleteQuota options.

func (*DeleteQuotaOptions) SetEntityName added in v1.3.0 

func (_options *DeleteQuotaOptions) SetEntityName(entityName string) *DeleteQuotaOptions

SetEntityName : Allow user to set EntityName

func (*DeleteQuotaOptions) SetHeaders added in v1.3.0 

func (options *DeleteQuotaOptions) SetHeaders(param map[string]string) *DeleteQuotaOptions

SetHeaders : Allow user to set Headers

type DeleteTopicOptions 

type DeleteTopicOptions struct {
	// The topic name for the topic to be deleted.
	TopicName *string `json:"topic_name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteTopicOptions : The DeleteTopic options.

func (*DeleteTopicOptions) SetHeaders 

func (options *DeleteTopicOptions) SetHeaders(param map[string]string) *DeleteTopicOptions

SetHeaders : Allow user to set Headers

func (*DeleteTopicOptions) SetTopicName 

func (_options *DeleteTopicOptions) SetTopicName(topicName string) *DeleteTopicOptions

SetTopicName : Allow user to set TopicName

type DeleteTopicRecordsOptions added in v1.4.1 

type DeleteTopicRecordsOptions struct {
	// The topic name of the records to be deleted.
	TopicName *string `json:"topic_name" validate:"required,ne="`

	RecordsToDelete []RecordDeleteRequestRecordsToDeleteItem `json:"records_to_delete,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteTopicRecordsOptions : The DeleteTopicRecords options.

func (*DeleteTopicRecordsOptions) SetHeaders added in v1.4.1 

func (options *DeleteTopicRecordsOptions) SetHeaders(param map[string]string) *DeleteTopicRecordsOptions

SetHeaders : Allow user to set Headers

func (*DeleteTopicRecordsOptions) SetRecordsToDelete added in v1.4.1 

func (_options *DeleteTopicRecordsOptions) SetRecordsToDelete(recordsToDelete []RecordDeleteRequestRecordsToDeleteItem) *DeleteTopicRecordsOptions

SetRecordsToDelete : Allow user to set RecordsToDelete

func (*DeleteTopicRecordsOptions) SetTopicName added in v1.4.1 

func (_options *DeleteTopicRecordsOptions) SetTopicName(topicName string) *DeleteTopicRecordsOptions

SetTopicName : Allow user to set TopicName

type EntityQuotaDetail added in v1.3.0 

type EntityQuotaDetail struct {
	// The name of the entity.
	EntityName *string `json:"entity_name" validate:"required"`

	// The producer byte rate quota value.
	ProducerByteRate *int64 `json:"producer_byte_rate,omitempty"`

	// The consumer byte rate quota value.
	ConsumerByteRate *int64 `json:"consumer_byte_rate,omitempty"`
}

EntityQuotaDetail : EntityQuotaDetail struct

type GetBrokerConfigOptions added in v1.4.1 

type GetBrokerConfigOptions struct {
	// The broker ID of the broker to be described.
	BrokerID *int64 `json:"broker_id" validate:"required"`

	// A filter to be applied to the config names. A simple filter can be specified as a string with asterisk (`*`)
	// wildcards representing 0 or more characters, e.g. `file*` will filter all config names that begin with the string
	// `file` followed by any character sequence. A more complex filter pattern can be used by surrounding a regular
	// expression in forward slash (`/`) delimiters, e.g. `/file.* /`.
	ConfigFilter *string `json:"config_filter,omitempty"`

	// When true, all information about the config properties is returned including the source of the configuration
	// indicating its scope and whether it's dynamic.
	Verbose *bool `json:"verbose,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetBrokerConfigOptions : The GetBrokerConfig options.

func (*GetBrokerConfigOptions) SetBrokerID added in v1.4.1 

func (_options *GetBrokerConfigOptions) SetBrokerID(brokerID int64) *GetBrokerConfigOptions

SetBrokerID : Allow user to set BrokerID

func (*GetBrokerConfigOptions) SetConfigFilter added in v1.4.1 

func (_options *GetBrokerConfigOptions) SetConfigFilter(configFilter string) *GetBrokerConfigOptions

SetConfigFilter : Allow user to set ConfigFilter

func (*GetBrokerConfigOptions) SetHeaders added in v1.4.1 

func (options *GetBrokerConfigOptions) SetHeaders(param map[string]string) *GetBrokerConfigOptions

SetHeaders : Allow user to set Headers

func (*GetBrokerConfigOptions) SetVerbose added in v1.4.1 

func (_options *GetBrokerConfigOptions) SetVerbose(verbose bool) *GetBrokerConfigOptions

SetVerbose : Allow user to set Verbose

type GetBrokerOptions added in v1.4.1 

type GetBrokerOptions struct {
	// The broker ID of the broker to be described.
	BrokerID *int64 `json:"broker_id" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetBrokerOptions : The GetBroker options.

func (*GetBrokerOptions) SetBrokerID added in v1.4.1 

func (_options *GetBrokerOptions) SetBrokerID(brokerID int64) *GetBrokerOptions

SetBrokerID : Allow user to set BrokerID

func (*GetBrokerOptions) SetHeaders added in v1.4.1 

func (options *GetBrokerOptions) SetHeaders(param map[string]string) *GetBrokerOptions

SetHeaders : Allow user to set Headers

type GetClusterOptions added in v1.4.1 

type GetClusterOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetClusterOptions : The GetCluster options.

func (*GetClusterOptions) SetHeaders added in v1.4.1 

func (options *GetClusterOptions) SetHeaders(param map[string]string) *GetClusterOptions

SetHeaders : Allow user to set Headers

type GetConsumerGroupOptions added in v1.4.1 

type GetConsumerGroupOptions struct {
	// The group ID for the consumer group to be described.
	GroupID *string `json:"group_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetConsumerGroupOptions : The GetConsumerGroup options.

func (*GetConsumerGroupOptions) SetGroupID added in v1.4.1 

func (_options *GetConsumerGroupOptions) SetGroupID(groupID string) *GetConsumerGroupOptions

SetGroupID : Allow user to set GroupID

func (*GetConsumerGroupOptions) SetHeaders added in v1.4.1 

func (options *GetConsumerGroupOptions) SetHeaders(param map[string]string) *GetConsumerGroupOptions

SetHeaders : Allow user to set Headers

type GetMirroringActiveTopicsOptions 

type GetMirroringActiveTopicsOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetMirroringActiveTopicsOptions : The GetMirroringActiveTopics options.

func (*GetMirroringActiveTopicsOptions) SetHeaders 

func (options *GetMirroringActiveTopicsOptions) SetHeaders(param map[string]string) *GetMirroringActiveTopicsOptions

SetHeaders : Allow user to set Headers

type GetMirroringTopicSelectionOptions 

type GetMirroringTopicSelectionOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetMirroringTopicSelectionOptions : The GetMirroringTopicSelection options.

func (*GetMirroringTopicSelectionOptions) SetHeaders 

func (options *GetMirroringTopicSelectionOptions) SetHeaders(param map[string]string) *GetMirroringTopicSelectionOptions

SetHeaders : Allow user to set Headers

type GetQuotaOptions added in v1.3.0 

type GetQuotaOptions struct {
	// The entity name of the quotas can be `default` or an IAM Service ID that starts with an `iam-ServiceId` prefix.
	EntityName *string `json:"entity_name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetQuotaOptions : The GetQuota options.

func (*GetQuotaOptions) SetEntityName added in v1.3.0 

func (_options *GetQuotaOptions) SetEntityName(entityName string) *GetQuotaOptions

SetEntityName : Allow user to set EntityName

func (*GetQuotaOptions) SetHeaders added in v1.3.0 

func (options *GetQuotaOptions) SetHeaders(param map[string]string) *GetQuotaOptions

SetHeaders : Allow user to set Headers

type GetTopicOptions 

type GetTopicOptions struct {
	// The topic name for the topic to be described.
	TopicName *string `json:"topic_name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetTopicOptions : The GetTopic options.

func (*GetTopicOptions) SetHeaders 

func (options *GetTopicOptions) SetHeaders(param map[string]string) *GetTopicOptions

SetHeaders : Allow user to set Headers

func (*GetTopicOptions) SetTopicName 

func (_options *GetTopicOptions) SetTopicName(topicName string) *GetTopicOptions

SetTopicName : Allow user to set TopicName

type GroupDetail added in v1.4.1 

type GroupDetail struct {
	// The ID of the consumer group.
	GroupID *string `json:"group_id,omitempty"`

	// THe state of the consumer group.
	State *string `json:"state,omitempty"`

	// Members in the consumer group.
	Members []Member `json:"members,omitempty"`

	// The offsets of the consumer group.
	Offsets []TopicPartitionOffset `json:"offsets,omitempty"`
}

GroupDetail : GroupDetail struct

type GroupResetResultsItem added in v1.4.1 

type GroupResetResultsItem struct {
	Topic *string `json:"topic,omitempty"`

	Partition *int64 `json:"partition,omitempty"`

	Offset *int64 `json:"offset,omitempty"`
}

GroupResetResultsItem : The new offset for one partition of one topic after resetting consumer group's offset.

type ListBrokersOptions added in v1.4.1 

type ListBrokersOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListBrokersOptions : The ListBrokers options.

func (*ListBrokersOptions) SetHeaders added in v1.4.1 

func (options *ListBrokersOptions) SetHeaders(param map[string]string) *ListBrokersOptions

SetHeaders : Allow user to set Headers

type ListConsumerGroupsOptions added in v1.4.1 

type ListConsumerGroupsOptions struct {
	// A filter to be applied to the consumer group IDs. A simple filter can be specified as a string with asterisk (`*`)
	// wildcards representing 0 or more characters, e.g. `group_id*` will filter all group IDs that begin with the string
	// `group_id` followed by any character sequence. A more complex filter pattern can be used by surrounding a regular
	// expression in forward slash (`/`) delimiters, e.g. `/group_id.* /`.
	GroupFilter *string `json:"group_filter,omitempty"`

	// The number of consumer groups to be returned.
	PerPage *int64 `json:"per_page,omitempty"`

	// The page number to be returned. The number 1 represents the first page. The default value is 1.
	Page *int64 `json:"page,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListConsumerGroupsOptions : The ListConsumerGroups options.

func (*ListConsumerGroupsOptions) SetGroupFilter added in v1.4.1 

func (_options *ListConsumerGroupsOptions) SetGroupFilter(groupFilter string) *ListConsumerGroupsOptions

SetGroupFilter : Allow user to set GroupFilter

func (*ListConsumerGroupsOptions) SetHeaders added in v1.4.1 

func (options *ListConsumerGroupsOptions) SetHeaders(param map[string]string) *ListConsumerGroupsOptions

SetHeaders : Allow user to set Headers

func (*ListConsumerGroupsOptions) SetPage added in v1.4.1 

func (_options *ListConsumerGroupsOptions) SetPage(page int64) *ListConsumerGroupsOptions

SetPage : Allow user to set Page

func (*ListConsumerGroupsOptions) SetPerPage added in v1.4.1 

func (_options *ListConsumerGroupsOptions) SetPerPage(perPage int64) *ListConsumerGroupsOptions

SetPerPage : Allow user to set PerPage

type ListQuotasOptions added in v1.3.0 

type ListQuotasOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListQuotasOptions : The ListQuotas options.

func (*ListQuotasOptions) SetHeaders added in v1.3.0 

func (options *ListQuotasOptions) SetHeaders(param map[string]string) *ListQuotasOptions

SetHeaders : Allow user to set Headers

type ListTopicsOptions 

type ListTopicsOptions struct {
	// A filter to be applied to the topic names. A simple filter can be specified as a string with asterisk (`*`)
	// wildcards representing 0 or more characters, e.g. `topic-name*` will filter all topic names that begin with the
	// string `topic-name` followed by any character sequence. A more complex filter pattern can be used by surrounding a
	// regular expression in forward slash (`/`) delimiters, e.g. `/topic-name.* /`.
	TopicFilter *string `json:"topic_filter,omitempty"`

	// The number of topic names to be returned.
	PerPage *int64 `json:"per_page,omitempty"`

	// The page number to be returned. The number 1 represents the first page. The default value is 1.
	Page *int64 `json:"page,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListTopicsOptions : The ListTopics options.

func (*ListTopicsOptions) SetHeaders 

func (options *ListTopicsOptions) SetHeaders(param map[string]string) *ListTopicsOptions

SetHeaders : Allow user to set Headers

func (*ListTopicsOptions) SetPage 

func (_options *ListTopicsOptions) SetPage(page int64) *ListTopicsOptions

SetPage : Allow user to set Page

func (*ListTopicsOptions) SetPerPage 

func (_options *ListTopicsOptions) SetPerPage(perPage int64) *ListTopicsOptions

SetPerPage : Allow user to set PerPage

func (*ListTopicsOptions) SetTopicFilter 

func (_options *ListTopicsOptions) SetTopicFilter(topicFilter string) *ListTopicsOptions

SetTopicFilter : Allow user to set TopicFilter

type Member added in v1.4.1 

type Member struct {
	// The consumer ID of the consumer group member.
	ConsumerID *string `json:"consumer_id,omitempty"`

	// The client ID of the consumer group member.
	ClientID *string `json:"client_id,omitempty"`

	// The hostname of the machine where the consumer group member is running.
	Host *string `json:"host,omitempty"`

	// The assignments of the group member.
	Assignments []MemberAssignmentsItem `json:"assignments,omitempty"`
}

Member : Member struct

type MemberAssignmentsItem added in v1.4.1 

type MemberAssignmentsItem struct {
	// The name of the topic.
	Topic *string `json:"topic,omitempty"`

	// The ID of the partition.
	Partition *int64 `json:"partition,omitempty"`
}

MemberAssignmentsItem : The topic partitions assigned for the consumer group member.

type MirroringActiveTopics 

type MirroringActiveTopics struct {
	ActiveTopics []string `json:"active_topics,omitempty"`
}

MirroringActiveTopics : Topics that are being actively mirrored.

type MirroringTopicSelection 

type MirroringTopicSelection struct {
	Includes []string `json:"includes,omitempty"`
}

MirroringTopicSelection : Mirroring topic selection payload.

type QuotaDetail added in v1.3.0 

type QuotaDetail struct {
	// The producer byte rate quota value.
	ProducerByteRate *int64 `json:"producer_byte_rate,omitempty"`

	// The consumer byte rate quota value.
	ConsumerByteRate *int64 `json:"consumer_byte_rate,omitempty"`
}

QuotaDetail : QuotaDetail struct

type QuotaList added in v1.4.1 

type QuotaList struct {
	Data []EntityQuotaDetail `json:"data,omitempty"`
}

QuotaList : A list of 'quota_detail' is returned.

type RecordDeleteRequestRecordsToDeleteItem added in v1.4.1 

type RecordDeleteRequestRecordsToDeleteItem struct {
	// The number of partitions.
	Partition *int64 `json:"partition,omitempty"`

	// The offset number before which records to be deleted.
	BeforeOffset *int64 `json:"before_offset,omitempty"`
}

RecordDeleteRequestRecordsToDeleteItem : RecordDeleteRequestRecordsToDeleteItem struct

type ReplaceMirroringTopicSelectionOptions 

type ReplaceMirroringTopicSelectionOptions struct {
	Includes []string `json:"includes,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ReplaceMirroringTopicSelectionOptions : The ReplaceMirroringTopicSelection options.

func (*ReplaceMirroringTopicSelectionOptions) SetHeaders 

func (options *ReplaceMirroringTopicSelectionOptions) SetHeaders(param map[string]string) *ReplaceMirroringTopicSelectionOptions

SetHeaders : Allow user to set Headers

func (*ReplaceMirroringTopicSelectionOptions) SetIncludes 

func (_options *ReplaceMirroringTopicSelectionOptions) SetIncludes(includes []string) *ReplaceMirroringTopicSelectionOptions

SetIncludes : Allow user to set Includes

type TopicConfigs 

type TopicConfigs struct {
	// The value of config property 'retention.bytes'.
	RetentionBytes *string `json:"retention.bytes,omitempty"`

	// The value of config property 'segment.bytes'.
	SegmentBytes *string `json:"segment.bytes,omitempty"`

	// The value of config property 'segment.index.bytes'.
	SegmentIndexBytes *string `json:"segment.index.bytes,omitempty"`

	// The value of config property 'segment.ms'.
	SegmentMs *string `json:"segment.ms,omitempty"`
}

TopicConfigs : TopicConfigs struct

type TopicCreateRequestConfigsItem added in v1.4.1 

type TopicCreateRequestConfigsItem struct {
	// The name of the config property.
	Name *string `json:"name,omitempty"`

	// The value for a config property.
	Value *string `json:"value,omitempty"`
}

TopicCreateRequestConfigsItem : TopicCreateRequestConfigsItem struct

type TopicDetail 

type TopicDetail struct {
	// The name of the topic.
	Name *string `json:"name,omitempty"`

	// The number of partitions.
	Partitions *int64 `json:"partitions,omitempty"`

	// The number of replication factor.
	ReplicationFactor *int64 `json:"replicationFactor,omitempty"`

	// The value of config property 'retention.ms'.
	RetentionMs *int64 `json:"retentionMs,omitempty"`

	// The value of config property 'cleanup.policy'.
	CleanupPolicy *string `json:"cleanupPolicy,omitempty"`

	Configs *TopicConfigs `json:"configs,omitempty"`

	// The replia assignment of the topic.
	ReplicaAssignments []TopicDetailReplicaAssignmentsItem `json:"replicaAssignments,omitempty"`
}

TopicDetail : TopicDetail struct

type TopicDetailReplicaAssignmentsItem added in v1.4.1 

type TopicDetailReplicaAssignmentsItem struct {
	// The ID of the partition.
	ID *int64 `json:"id,omitempty"`

	Brokers *TopicDetailReplicaAssignmentsItemBrokers `json:"brokers,omitempty"`
}

TopicDetailReplicaAssignmentsItem : TopicDetailReplicaAssignmentsItem struct

type TopicDetailReplicaAssignmentsItemBrokers added in v1.4.1 

type TopicDetailReplicaAssignmentsItemBrokers struct {
	Replicas []int64 `json:"replicas,omitempty"`
}

TopicDetailReplicaAssignmentsItemBrokers : TopicDetailReplicaAssignmentsItemBrokers struct

type TopicPartitionOffset added in v1.4.1 

type TopicPartitionOffset struct {
	// The name of the topic.
	Topic *string `json:"topic,omitempty"`

	// The ID of the partition.
	Partition *int64 `json:"partition,omitempty"`

	// Current offset of the partition.
	CurrentOffset *int64 `json:"current_offset,omitempty"`

	// End offset of the partition.
	EndOffset *int64 `json:"end_offset,omitempty"`
}

TopicPartitionOffset : The offsets of a topic partition.

type TopicUpdateRequestConfigsItem added in v1.4.1 

type TopicUpdateRequestConfigsItem struct {
	// The name of the config property.
	Name *string `json:"name,omitempty"`

	// The value of a config property.
	Value *string `json:"value,omitempty"`

	// When true, the value of the config property is reset to its default value.
	ResetToDefault *bool `json:"reset_to_default,omitempty"`
}

TopicUpdateRequestConfigsItem : TopicUpdateRequestConfigsItem struct

type UpdateConsumerGroupOptions added in v1.4.1 

type UpdateConsumerGroupOptions struct {
	// The group ID for the consumer group to be updated.
	GroupID *string `json:"group_id" validate:"required,ne="`

	// The name of the topic to be reset.  If missing or blank, the operation applies to all topics read by the consumer
	// group.
	Topic *string `json:"topic,omitempty"`

	// Mode of shift operation.  Valid values are 'earliest', 'latest', 'datetime'.
	Mode *string `json:"mode,omitempty"`

	// Value for resetting offsets, based on 'mode=datetime', omit for 'earliest' and 'latest'.
	Value *string `json:"value,omitempty"`

	// Whether to execute the operation of resetting the offsets.
	Execute *bool `json:"execute,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateConsumerGroupOptions : The UpdateConsumerGroup options.

func (*UpdateConsumerGroupOptions) SetExecute added in v1.4.1 

func (_options *UpdateConsumerGroupOptions) SetExecute(execute bool) *UpdateConsumerGroupOptions

SetExecute : Allow user to set Execute

func (*UpdateConsumerGroupOptions) SetGroupID added in v1.4.1 

func (_options *UpdateConsumerGroupOptions) SetGroupID(groupID string) *UpdateConsumerGroupOptions

SetGroupID : Allow user to set GroupID

func (*UpdateConsumerGroupOptions) SetHeaders added in v1.4.1 

func (options *UpdateConsumerGroupOptions) SetHeaders(param map[string]string) *UpdateConsumerGroupOptions

SetHeaders : Allow user to set Headers

func (*UpdateConsumerGroupOptions) SetMode added in v1.4.1 

func (_options *UpdateConsumerGroupOptions) SetMode(mode string) *UpdateConsumerGroupOptions

SetMode : Allow user to set Mode

func (*UpdateConsumerGroupOptions) SetTopic added in v1.4.1 

func (_options *UpdateConsumerGroupOptions) SetTopic(topic string) *UpdateConsumerGroupOptions

SetTopic : Allow user to set Topic

func (*UpdateConsumerGroupOptions) SetValue added in v1.4.1 

func (_options *UpdateConsumerGroupOptions) SetValue(value string) *UpdateConsumerGroupOptions

SetValue : Allow user to set Value

type UpdateQuotaOptions added in v1.3.0 

type UpdateQuotaOptions struct {
	// The entity name of the quotas can be `default` or an IAM Service ID that starts with an `iam-ServiceId` prefix.
	EntityName *string `json:"entity_name" validate:"required,ne="`

	// The producer byte rate quota value.
	ProducerByteRate *int64 `json:"producer_byte_rate,omitempty"`

	// The consumer byte rate quota value.
	ConsumerByteRate *int64 `json:"consumer_byte_rate,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateQuotaOptions : The UpdateQuota options.

func (*UpdateQuotaOptions) SetConsumerByteRate added in v1.3.0 

func (_options *UpdateQuotaOptions) SetConsumerByteRate(consumerByteRate int64) *UpdateQuotaOptions

SetConsumerByteRate : Allow user to set ConsumerByteRate

func (*UpdateQuotaOptions) SetEntityName added in v1.3.0 

func (_options *UpdateQuotaOptions) SetEntityName(entityName string) *UpdateQuotaOptions

SetEntityName : Allow user to set EntityName

func (*UpdateQuotaOptions) SetHeaders added in v1.3.0 

func (options *UpdateQuotaOptions) SetHeaders(param map[string]string) *UpdateQuotaOptions

SetHeaders : Allow user to set Headers

func (*UpdateQuotaOptions) SetProducerByteRate added in v1.3.0 

func (_options *UpdateQuotaOptions) SetProducerByteRate(producerByteRate int64) *UpdateQuotaOptions

SetProducerByteRate : Allow user to set ProducerByteRate

type UpdateTopicOptions 

type UpdateTopicOptions struct {
	// The topic name for the topic to be updated.
	TopicName *string `json:"topic_name" validate:"required,ne="`

	// The new partition number to be increased to.
	NewTotalPartitionCount *int64 `json:"new_total_partition_count,omitempty"`

	// The config properties to be updated for the topic. Valid config names are 'cleanup.policy', 'retention.ms',
	// 'retention.bytes', 'segment.bytes', 'segment.ms', 'segment.index.bytes'.
	Configs []TopicUpdateRequestConfigsItem `json:"configs,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateTopicOptions : The UpdateTopic options.

func (*UpdateTopicOptions) SetConfigs 

func (_options *UpdateTopicOptions) SetConfigs(configs []TopicUpdateRequestConfigsItem) *UpdateTopicOptions

SetConfigs : Allow user to set Configs

func (*UpdateTopicOptions) SetHeaders 

func (options *UpdateTopicOptions) SetHeaders(param map[string]string) *UpdateTopicOptions

SetHeaders : Allow user to set Headers

func (*UpdateTopicOptions) SetNewTotalPartitionCount 

func (_options *UpdateTopicOptions) SetNewTotalPartitionCount(newTotalPartitionCount int64) *UpdateTopicOptions

SetNewTotalPartitionCount : Allow user to set NewTotalPartitionCount

func (*UpdateTopicOptions) SetTopicName 

func (_options *UpdateTopicOptions) SetTopicName(topicName string) *UpdateTopicOptions

SetTopicName : Allow user to set TopicName

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.