kafkarestv3

package module
v0.3.18 Latest Latest
Warning

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

Go to latest
Published: Jan 18, 2024 License: Apache-2.0 Imports: 23 Imported by: 6

README

Go API client for kafkarestv3

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./kafkarestv3"

Documentation for API Endpoints

All URIs are relative to http://localhost:8082/v3

Class Method HTTP request Description
ACLV3Api CreateKafkaAcls Post /clusters/{cluster_id}/acls Create ACLs
ACLV3Api DeleteKafkaAcls Delete /clusters/{cluster_id}/acls Delete ACLs
ACLV3Api GetKafkaAcls Get /clusters/{cluster_id}/acls Search ACLs
BalancerStatusV3Api ClustersClusterIdBalancerAnyUnevenLoadGet Get /clusters/{cluster_id}/balancer/any-uneven-load Get AnyUnevenLoad status
BalancerStatusV3Api ClustersClusterIdBalancerGet Get /clusters/{cluster_id}/balancer Get status of the balancer
BrokerApi ClustersClusterIdBrokersdeletePost Post /clusters/{cluster_id}/brokers:delete Delete several brokers
BrokerReplicaExclusionApi ClustersClusterIdBrokerReplicaExclusionsBrokerIdGet Get /clusters/{cluster_id}/broker-replica-exclusions/{broker_id} Get a Broker Replica Exclusions.
BrokerReplicaExclusionApi ClustersClusterIdBrokerReplicaExclusionsGet Get /clusters/{cluster_id}/broker-replica-exclusions Get all Broker Replica Exclusions.
BrokerReplicaExclusionApi ClustersClusterIdBrokerReplicaExclusionscreatePost Post /clusters/{cluster_id}/broker-replica-exclusions:create Create Broker Replica Exclusions
BrokerReplicaExclusionApi ClustersClusterIdBrokerReplicaExclusionsdeletePost Post /clusters/{cluster_id}/broker-replica-exclusions:delete Delete Broker Replica Exclusions
BrokerTaskApi ClustersClusterIdBrokersBrokerIdTasksGet Get /clusters/{cluster_id}/brokers/{broker_id}/tasks List Broker Tasks of a specific Broker
BrokerTaskApi ClustersClusterIdBrokersBrokerIdTasksTaskTypeGet Get /clusters/{cluster_id}/brokers/{broker_id}/tasks/{task_type} Get single Broker Task.
BrokerTaskApi ClustersClusterIdBrokersTasksGet Get /clusters/{cluster_id}/brokers/-/tasks List Broker Tasks
BrokerTaskApi ClustersClusterIdBrokersTasksTaskTypeGet Get /clusters/{cluster_id}/brokers/-/tasks/{task_type} List Broker Tasks of a specific TaskType
BrokerV3Api ClustersClusterIdBrokersBrokerIdDelete Delete /clusters/{cluster_id}/brokers/{broker_id} Delete Broker
BrokerV3Api ClustersClusterIdBrokersBrokerIdGet Get /clusters/{cluster_id}/brokers/{broker_id} Get Broker
BrokerV3Api ClustersClusterIdBrokersBrokerIdPartitionReplicasGet Get /clusters/{cluster_id}/brokers/{broker_id}/partition-replicas Search Replicas by Broker
BrokerV3Api ClustersClusterIdBrokersGet Get /clusters/{cluster_id}/brokers List Brokers
ClusterLinkingV3Api CreateKafkaLink Post /clusters/{cluster_id}/links Create a cluster link
ClusterLinkingV3Api CreateKafkaMirrorTopic Post /clusters/{cluster_id}/links/{link_name}/mirrors Create a mirror topic
ClusterLinkingV3Api DeleteKafkaLink Delete /clusters/{cluster_id}/links/{link_name} Delete the cluster link
ClusterLinkingV3Api DeleteKafkaLinkConfig Delete /clusters/{cluster_id}/links/{link_name}/configs/{config_name} Reset the given config to default value
ClusterLinkingV3Api GetKafkaLink Get /clusters/{cluster_id}/links/{link_name} Describe the cluster link
ClusterLinkingV3Api GetKafkaLinkConfigs Get /clusters/{cluster_id}/links/{link_name}/configs/{config_name} Describe the config under the cluster link
ClusterLinkingV3Api ListKafkaLinkConfigs Get /clusters/{cluster_id}/links/{link_name}/configs List all configs of the cluster link
ClusterLinkingV3Api ListKafkaLinks Get /clusters/{cluster_id}/links List all cluster links in the dest cluster
ClusterLinkingV3Api ListKafkaMirrorTopics Get /clusters/{cluster_id}/links/-/mirrors List mirror topics
ClusterLinkingV3Api ListKafkaMirrorTopicsUnderLink Get /clusters/{cluster_id}/links/{link_name}/mirrors List mirror topics
ClusterLinkingV3Api ReadKafkaMirrorTopic Get /clusters/{cluster_id}/links/{link_name}/mirrors/{mirror_topic_name} Describe the mirror topic
ClusterLinkingV3Api UpdateKafkaLinkConfig Put /clusters/{cluster_id}/links/{link_name}/configs/{config_name} Alter the config under the cluster link
ClusterLinkingV3Api UpdateKafkaLinkConfigBatch Put /clusters/{cluster_id}/links/{link_name}/configs:alter Batch Alter Cluster Link Configs
ClusterLinkingV3Api UpdateKafkaMirrorTopicsFailover Post /clusters/{cluster_id}/links/{link_name}/mirrors:failover Failover the mirror topics
ClusterLinkingV3Api UpdateKafkaMirrorTopicsPause Post /clusters/{cluster_id}/links/{link_name}/mirrors:pause Pause the mirror topics
ClusterLinkingV3Api UpdateKafkaMirrorTopicsPromote Post /clusters/{cluster_id}/links/{link_name}/mirrors:promote Promote the mirror topics
ClusterLinkingV3Api UpdateKafkaMirrorTopicsPromoteLocalAndPauseRemoteMirror Post /clusters/{cluster_id}/links/{link_name}/mirrors:promote-local-and-pause-remote-mirror Promote the local mirror topic and Pause the remote mirror topic
ClusterLinkingV3Api UpdateKafkaMirrorTopicsPromoteLocalAndStartRemoteMirror Post /clusters/{cluster_id}/links/{link_name}/mirrors:promote-local-and-start-remote-mirror Promote the local mirror topic and start the remote mirror topic
ClusterLinkingV3Api UpdateKafkaMirrorTopicsResume Post /clusters/{cluster_id}/links/{link_name}/mirrors:resume Resume the mirror topics
ClusterV3Api ClustersGet Get /clusters List Clusters
ClusterV3Api GetKafkaCluster Get /clusters/{cluster_id} Get Cluster
ConfigsV3Api ClustersClusterIdBrokersBrokerIdConfigsGet Get /clusters/{cluster_id}/brokers/{broker_id}/configs List Broker Configs
ConfigsV3Api ClustersClusterIdBrokersBrokerIdConfigsNameDelete Delete /clusters/{cluster_id}/brokers/{broker_id}/configs/{name} Reset Broker Config
ConfigsV3Api ClustersClusterIdBrokersBrokerIdConfigsNameGet Get /clusters/{cluster_id}/brokers/{broker_id}/configs/{name} Get Broker Config
ConfigsV3Api ClustersClusterIdBrokersBrokerIdConfigsNamePut Put /clusters/{cluster_id}/brokers/{broker_id}/configs/{name} Update Broker Config
ConfigsV3Api ClustersClusterIdBrokersBrokerIdConfigsalterPost Post /clusters/{cluster_id}/brokers/{broker_id}/configs:alter Batch Alter Broker Configs
ConfigsV3Api ClustersClusterIdBrokersConfigsGet Get /clusters/{cluster_id}/brokers/-/configs List All Broker Configs
ConfigsV3Api DeleteKafkaClusterConfig Delete /clusters/{cluster_id}/broker-configs/{name} Reset Cluster Config
ConfigsV3Api DeleteKafkaTopicConfig Delete /clusters/{cluster_id}/topics/{topic_name}/configs/{name} Reset Topic Config
ConfigsV3Api GetKafkaClusterConfig Get /clusters/{cluster_id}/broker-configs/{name} Get Cluster Config
ConfigsV3Api GetKafkaTopicConfig Get /clusters/{cluster_id}/topics/{topic_name}/configs/{name} Get Topic Config
ConfigsV3Api ListKafkaAllTopicConfigs Get /clusters/{cluster_id}/topics/-/configs Get All Topic Configs
ConfigsV3Api ListKafkaClusterConfigs Get /clusters/{cluster_id}/broker-configs List Cluster Configs
ConfigsV3Api ListKafkaDefaultTopicConfigs Get /clusters/{cluster_id}/topics/{topic_name}/default-configs List Default Topic Configs
ConfigsV3Api ListKafkaTopicConfigs Get /clusters/{cluster_id}/topics/{topic_name}/configs List Topic Configs
ConfigsV3Api UpdateKafkaClusterConfig Put /clusters/{cluster_id}/broker-configs/{name} Update Cluster Config
ConfigsV3Api UpdateKafkaClusterConfigs Post /clusters/{cluster_id}/broker-configs:alter Batch Alter Cluster Configs
ConfigsV3Api UpdateKafkaTopicConfig Put /clusters/{cluster_id}/topics/{topic_name}/configs/{name} Update Topic Config
ConfigsV3Api UpdateKafkaTopicConfigBatch Post /clusters/{cluster_id}/topics/{topic_name}/configs:alter Batch Alter Topic Configs
ConsumerGroupV3Api GetKafkaConsumer Get /clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id} Get Consumer
ConsumerGroupV3Api GetKafkaConsumerAssignment Get /clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id}/assignments/{topic_name}/partitions/{partition_id} Get Consumer Assignment
ConsumerGroupV3Api GetKafkaConsumerGroup Get /clusters/{cluster_id}/consumer-groups/{consumer_group_id} Get Consumer Group
ConsumerGroupV3Api GetKafkaConsumerGroupLagSummary Get /clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary Get Consumer Group Lag Summary.
ConsumerGroupV3Api ListKafkaConsumerAssignment Get /clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id}/assignments List Consumer Assignments
ConsumerGroupV3Api ListKafkaConsumerGroups Get /clusters/{cluster_id}/consumer-groups List Consumer Groups
ConsumerGroupV3Api ListKafkaConsumerLags Get /clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags List Consumer Lags
ConsumerGroupV3Api ListKafkaConsumers Get /clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers List Consumers
PartitionApi ClustersClusterIdTopicsPartitionsReassignmentGet Get /clusters/{cluster_id}/topics/-/partitions/-/reassignment List All Replica Reassignments
PartitionApi ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReassignmentGet Get /clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}/reassignment Get Replica Reassignments
PartitionApi ClustersClusterIdTopicsTopicNamePartitionsReassignmentGet Get /clusters/{cluster_id}/topics/{topic_name}/partitions/-/reassignment Search Replica Reassignments By Topic
PartitionV3Api GetKafkaConsumerLag Get /clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags/{topic_name}/partitions/{partition_id} Get Consumer Lag
PartitionV3Api GetKafkaPartition Get /clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id} Get Partition
PartitionV3Api ListKafkaPartitions Get /clusters/{cluster_id}/topics/{topic_name}/partitions List Partitions
RecordsV3Api ClustersClusterIdTopicsTopicNameRecordsPost Post /clusters/{cluster_id}/topics/{topic_name}/records Produce records to the given topic.
RemoveBrokerTaskApi ClustersClusterIdRemoveBrokerTasksBrokerIdGet Get /clusters/{cluster_id}/remove-broker-tasks/{broker_id} Get Remove Broker Task
RemoveBrokerTaskApi ClustersClusterIdRemoveBrokerTasksGet Get /clusters/{cluster_id}/remove-broker-tasks List Remove Broker Tasks
ReplicaApi ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicasBrokerIdGet Get /clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}/replicas/{broker_id} Get Replica
ReplicaApi ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicasGet Get /clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}/replicas List Replicas
ReplicaStatusApi ClustersClusterIdTopicsPartitionsReplicaStatusGet Get /clusters/{cluster_id}/topics/-/partitions/-/replica-status List All Replica Statuses from a cluster.
ReplicaStatusApi ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicaStatusGet Get /clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}/replica-status List Partition Replica Statuses.
ReplicaStatusApi ClustersClusterIdTopicsTopicNamePartitionsReplicaStatusGet Get /clusters/{cluster_id}/topics/{topic_name}/partitions/-/replica-status List All Partition Replica Statuses.
ReplicaV3Api ClustersClusterIdBrokersBrokerIdPartitionReplicasGet Get /clusters/{cluster_id}/brokers/{broker_id}/partition-replicas Search Replicas by Broker
TopicV3Api CreateKafkaTopic Post /clusters/{cluster_id}/topics Create Topic
TopicV3Api DeleteKafkaTopic Delete /clusters/{cluster_id}/topics/{topic_name} Delete Topic
TopicV3Api GetKafkaTopic Get /clusters/{cluster_id}/topics/{topic_name} Get Topic
TopicV3Api ListKafkaTopics Get /clusters/{cluster_id}/topics List Topics
UnregisterV3Api ClustersClusterIdBrokersBrokerIdunregisterPost Post /clusters/{cluster_id}/brokers/{broker_id}:unregister Unregister a Broker

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

kafka-clients-proxy-team@confluent.io

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type ACLV3Api added in v0.3.8

type ACLV3Api interface {

	/*
	 * CreateKafkaAcls Create ACLs
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Creates an ACL.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param optional nil or *CreateKafkaAclsOpts - Optional Parameters:
	 * @param "CreateAclRequestData" (optional.Interface of CreateAclRequestData) -  The ACL creation request.
	 */
	CreateKafkaAcls(ctx _context.Context, clusterId string, localVarOptionals *CreateKafkaAclsOpts) (*_nethttp.Response, error)

	/*
	 * DeleteKafkaAcls Delete ACLs
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Deletes the list of ACLs that matches the search criteria.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param optional nil or *DeleteKafkaAclsOpts - Optional Parameters:
	 * @param "ResourceType" (optional.Interface of AclResourceType) -  The ACL resource type.
	 * @param "ResourceName" (optional.String) -  The ACL resource name.
	 * @param "PatternType" (optional.String) -  The ACL pattern type.
	 * @param "Principal" (optional.String) -  The ACL principal.
	 * @param "Host" (optional.String) -  The ACL host.
	 * @param "Operation" (optional.String) -  The ACL operation.
	 * @param "Permission" (optional.String) -  The ACL permission.
	 * @return InlineResponse200
	 */
	DeleteKafkaAcls(ctx _context.Context, clusterId string, localVarOptionals *DeleteKafkaAclsOpts) (InlineResponse200, *_nethttp.Response, error)

	/*
	 * GetKafkaAcls Search ACLs
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns a list of ACLs that match the search criteria.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param optional nil or *GetKafkaAclsOpts - Optional Parameters:
	 * @param "ResourceType" (optional.Interface of AclResourceType) -  The ACL resource type.
	 * @param "ResourceName" (optional.String) -  The ACL resource name.
	 * @param "PatternType" (optional.String) -  The ACL pattern type.
	 * @param "Principal" (optional.String) -  The ACL principal.
	 * @param "Host" (optional.String) -  The ACL host.
	 * @param "Operation" (optional.String) -  The ACL operation.
	 * @param "Permission" (optional.String) -  The ACL permission.
	 * @return AclDataList
	 */
	GetKafkaAcls(ctx _context.Context, clusterId string, localVarOptionals *GetKafkaAclsOpts) (AclDataList, *_nethttp.Response, error)
}

type ACLV3ApiService added in v0.3.8

type ACLV3ApiService service

ACLV3ApiService ACLV3Api service

func (*ACLV3ApiService) CreateKafkaAcls added in v0.3.8

func (a *ACLV3ApiService) CreateKafkaAcls(ctx _context.Context, clusterId string, localVarOptionals *CreateKafkaAclsOpts) (*_nethttp.Response, error)

* CreateKafkaAcls Create ACLs * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Creates an ACL. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param optional nil or *CreateKafkaAclsOpts - Optional Parameters: * @param "CreateAclRequestData" (optional.Interface of CreateAclRequestData) - The ACL creation request.

func (*ACLV3ApiService) DeleteKafkaAcls added in v0.3.8

func (a *ACLV3ApiService) DeleteKafkaAcls(ctx _context.Context, clusterId string, localVarOptionals *DeleteKafkaAclsOpts) (InlineResponse200, *_nethttp.Response, error)

* DeleteKafkaAcls Delete ACLs * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Deletes the list of ACLs that matches the search criteria. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param optional nil or *DeleteKafkaAclsOpts - Optional Parameters: * @param "ResourceType" (optional.Interface of AclResourceType) - The ACL resource type. * @param "ResourceName" (optional.String) - The ACL resource name. * @param "PatternType" (optional.String) - The ACL pattern type. * @param "Principal" (optional.String) - The ACL principal. * @param "Host" (optional.String) - The ACL host. * @param "Operation" (optional.String) - The ACL operation. * @param "Permission" (optional.String) - The ACL permission. * @return InlineResponse200

func (*ACLV3ApiService) GetKafkaAcls added in v0.3.8

func (a *ACLV3ApiService) GetKafkaAcls(ctx _context.Context, clusterId string, localVarOptionals *GetKafkaAclsOpts) (AclDataList, *_nethttp.Response, error)

* GetKafkaAcls Search ACLs * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns a list of ACLs that match the search criteria. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param optional nil or *GetKafkaAclsOpts - Optional Parameters: * @param "ResourceType" (optional.Interface of AclResourceType) - The ACL resource type. * @param "ResourceName" (optional.String) - The ACL resource name. * @param "PatternType" (optional.String) - The ACL pattern type. * @param "Principal" (optional.String) - The ACL principal. * @param "Host" (optional.String) - The ACL host. * @param "Operation" (optional.String) - The ACL operation. * @param "Permission" (optional.String) - The ACL permission. * @return AclDataList

type APIClient

type APIClient struct {
	ACLV3Api ACLV3Api

	BalancerStatusV3Api BalancerStatusV3Api

	BrokerApi BrokerApi

	BrokerReplicaExclusionApi BrokerReplicaExclusionApi

	BrokerTaskApi BrokerTaskApi

	BrokerV3Api BrokerV3Api

	ClusterLinkingV3Api ClusterLinkingV3Api

	ClusterV3Api ClusterV3Api

	ConfigsV3Api ConfigsV3Api

	ConsumerGroupV3Api ConsumerGroupV3Api

	PartitionApi PartitionApi

	PartitionV3Api PartitionV3Api

	RecordsV3Api RecordsV3Api

	RemoveBrokerTaskApi RemoveBrokerTaskApi

	ReplicaApi ReplicaApi

	ReplicaStatusApi ReplicaStatusApi

	ReplicaV3Api ReplicaV3Api

	TopicV3Api TopicV3Api

	UnregisterV3Api UnregisterV3Api
	// contains filtered or unexported fields
}

APIClient manages communication with the REST Admin API API v3.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type AbstractConfigData

type AbstractConfigData struct {
	Kind        string              `json:"kind"`
	Metadata    ResourceMetadata    `json:"metadata"`
	ClusterId   string              `json:"cluster_id"`
	Name        string              `json:"name"`
	Value       *string             `json:"value,omitempty"`
	IsDefault   bool                `json:"is_default"`
	IsReadOnly  bool                `json:"is_read_only"`
	IsSensitive bool                `json:"is_sensitive"`
	Source      string              `json:"source"`
	Synonyms    []ConfigSynonymData `json:"synonyms"`
}

AbstractConfigData struct for AbstractConfigData

type AbstractConfigDataAllOf

type AbstractConfigDataAllOf struct {
	ClusterId   string              `json:"cluster_id"`
	Name        string              `json:"name"`
	Value       *string             `json:"value,omitempty"`
	IsDefault   bool                `json:"is_default"`
	IsReadOnly  bool                `json:"is_read_only"`
	IsSensitive bool                `json:"is_sensitive"`
	Source      string              `json:"source"`
	Synonyms    []ConfigSynonymData `json:"synonyms"`
}

AbstractConfigDataAllOf struct for AbstractConfigDataAllOf

type AclData

type AclData struct {
	Kind         string           `json:"kind"`
	Metadata     ResourceMetadata `json:"metadata"`
	ClusterId    string           `json:"cluster_id"`
	ResourceType AclResourceType  `json:"resource_type"`
	ResourceName string           `json:"resource_name"`
	PatternType  string           `json:"pattern_type"`
	Principal    string           `json:"principal"`
	Host         string           `json:"host"`
	Operation    string           `json:"operation"`
	Permission   string           `json:"permission"`
}

AclData struct for AclData

type AclDataAllOf

type AclDataAllOf struct {
	ClusterId    string          `json:"cluster_id"`
	ResourceType AclResourceType `json:"resource_type"`
	ResourceName string          `json:"resource_name"`
	PatternType  string          `json:"pattern_type"`
	Principal    string          `json:"principal"`
	Host         string          `json:"host"`
	Operation    string          `json:"operation"`
	Permission   string          `json:"permission"`
}

AclDataAllOf struct for AclDataAllOf

type AclDataList

type AclDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []AclData                  `json:"data"`
}

AclDataList struct for AclDataList

type AclResourceType

type AclResourceType string

AclResourceType the model 'AclResourceType'

const (
	ACLRESOURCETYPE_UNKNOWN          AclResourceType = "UNKNOWN"
	ACLRESOURCETYPE_ANY              AclResourceType = "ANY"
	ACLRESOURCETYPE_TOPIC            AclResourceType = "TOPIC"
	ACLRESOURCETYPE_GROUP            AclResourceType = "GROUP"
	ACLRESOURCETYPE_CLUSTER          AclResourceType = "CLUSTER"
	ACLRESOURCETYPE_TRANSACTIONAL_ID AclResourceType = "TRANSACTIONAL_ID"
	ACLRESOURCETYPE_DELEGATION_TOKEN AclResourceType = "DELEGATION_TOKEN"
)

List of AclResourceType

type AlterBrokerReplicaExclusionData added in v0.3.8

type AlterBrokerReplicaExclusionData struct {
	Kind         string           `json:"kind"`
	Metadata     ResourceMetadata `json:"metadata"`
	ClusterId    string           `json:"cluster_id"`
	BrokerId     int32            `json:"broker_id"`
	Exclusion    string           `json:"exclusion"`
	Reason       string           `json:"reason"`
	ErrorCode    *int32           `json:"error_code,omitempty"`
	ErrorMessage *string          `json:"error_message,omitempty"`
	Broker       Relationship     `json:"broker"`
}

AlterBrokerReplicaExclusionData struct for AlterBrokerReplicaExclusionData

type AlterBrokerReplicaExclusionDataAllOf added in v0.3.8

type AlterBrokerReplicaExclusionDataAllOf struct {
	ClusterId    string       `json:"cluster_id"`
	BrokerId     int32        `json:"broker_id"`
	Exclusion    string       `json:"exclusion"`
	Reason       string       `json:"reason"`
	ErrorCode    *int32       `json:"error_code,omitempty"`
	ErrorMessage *string      `json:"error_message,omitempty"`
	Broker       Relationship `json:"broker"`
}

AlterBrokerReplicaExclusionDataAllOf struct for AlterBrokerReplicaExclusionDataAllOf

type AlterBrokerReplicaExclusionDataList added in v0.3.8

type AlterBrokerReplicaExclusionDataList struct {
	Kind     string                            `json:"kind"`
	Metadata ResourceCollectionMetadata        `json:"metadata"`
	Data     []AlterBrokerReplicaExclusionData `json:"data"`
}

AlterBrokerReplicaExclusionDataList struct for AlterBrokerReplicaExclusionDataList

type AlterBrokerReplicaExclusionDataListAllOf added in v0.3.8

type AlterBrokerReplicaExclusionDataListAllOf struct {
	Data []AlterBrokerReplicaExclusionData `json:"data"`
}

AlterBrokerReplicaExclusionDataListAllOf struct for AlterBrokerReplicaExclusionDataListAllOf

type AlterConfigBatchRequestData

type AlterConfigBatchRequestData struct {
	Data []AlterConfigBatchRequestDataData `json:"data"`
}

AlterConfigBatchRequestData struct for AlterConfigBatchRequestData

type AlterConfigBatchRequestDataData

type AlterConfigBatchRequestDataData struct {
	Name      string  `json:"name"`
	Value     *string `json:"value,omitempty"`
	Operation *string `json:"operation,omitempty"`
}

AlterConfigBatchRequestDataData struct for AlterConfigBatchRequestDataData

type AlterMirrorStatusResponseData

type AlterMirrorStatusResponseData struct {
	Kind            string           `json:"kind"`
	Metadata        ResourceMetadata `json:"metadata"`
	MirrorTopicName string           `json:"mirror_topic_name"`
	ErrorMessage    *string          `json:"error_message"`
	ErrorCode       *int32           `json:"error_code"`
	MirrorLags      []MirrorLag      `json:"mirror_lags"`
}

AlterMirrorStatusResponseData struct for AlterMirrorStatusResponseData

type AlterMirrorStatusResponseDataAllOf

type AlterMirrorStatusResponseDataAllOf struct {
	MirrorTopicName string      `json:"mirror_topic_name"`
	ErrorMessage    *string     `json:"error_message"`
	ErrorCode       *int32      `json:"error_code"`
	MirrorLags      []MirrorLag `json:"mirror_lags"`
}

AlterMirrorStatusResponseDataAllOf struct for AlterMirrorStatusResponseDataAllOf

type AlterMirrorStatusResponseDataList

type AlterMirrorStatusResponseDataList struct {
	Kind     string                          `json:"kind"`
	Metadata ResourceCollectionMetadata      `json:"metadata"`
	Data     []AlterMirrorStatusResponseData `json:"data"`
}

AlterMirrorStatusResponseDataList struct for AlterMirrorStatusResponseDataList

type AlterMirrorStatusResponseDataListAllOf

type AlterMirrorStatusResponseDataListAllOf struct {
	Data []AlterMirrorStatusResponseData `json:"data"`
}

AlterMirrorStatusResponseDataListAllOf struct for AlterMirrorStatusResponseDataListAllOf

type AlterMirrorsRequestData

type AlterMirrorsRequestData struct {
	// The mirror topics specified as a list of topic names.
	MirrorTopicNames []string `json:"mirror_topic_names,omitempty"`
	// The mirror topics specified as a pattern.
	MirrorTopicNamePattern string `json:"mirror_topic_name_pattern,omitempty"`
}

AlterMirrorsRequestData struct for AlterMirrorsRequestData

type AnyUnevenLoadData

type AnyUnevenLoadData struct {
	Kind           string           `json:"kind"`
	Metadata       ResourceMetadata `json:"metadata"`
	ClusterId      string           `json:"cluster_id"`
	Status         string           `json:"status"`
	PreviousStatus string           `json:"previous_status"`
	// The date and time at which this task was created.
	StatusUpdatedAt time.Time `json:"status_updated_at"`
	// The date and time at which this task was created.
	PreviousStatusUpdatedAt time.Time    `json:"previous_status_updated_at"`
	ErrorCode               *int32       `json:"error_code,omitempty"`
	ErrorMessage            *string      `json:"error_message,omitempty"`
	BrokerTasks             Relationship `json:"broker_tasks"`
}

AnyUnevenLoadData struct for AnyUnevenLoadData

type AnyUnevenLoadDataAllOf

type AnyUnevenLoadDataAllOf struct {
	ClusterId      string `json:"cluster_id"`
	Status         string `json:"status"`
	PreviousStatus string `json:"previous_status"`
	// The date and time at which this task was created.
	StatusUpdatedAt time.Time `json:"status_updated_at"`
	// The date and time at which this task was created.
	PreviousStatusUpdatedAt time.Time    `json:"previous_status_updated_at"`
	ErrorCode               *int32       `json:"error_code,omitempty"`
	ErrorMessage            *string      `json:"error_message,omitempty"`
	BrokerTasks             Relationship `json:"broker_tasks"`
}

AnyUnevenLoadDataAllOf struct for AnyUnevenLoadDataAllOf

type BalancerStatusData

type BalancerStatusData struct {
	Kind          string           `json:"kind"`
	Metadata      ResourceMetadata `json:"metadata"`
	ClusterId     string           `json:"cluster_id"`
	Status        string           `json:"status"`
	ErrorCode     *int32           `json:"error_code,omitempty"`
	ErrorMessage  *string          `json:"error_message,omitempty"`
	AnyUnevenLoad Relationship     `json:"any_uneven_load"`
	BrokerTasks   Relationship     `json:"broker_tasks"`
}

BalancerStatusData struct for BalancerStatusData

type BalancerStatusDataAllOf

type BalancerStatusDataAllOf struct {
	ClusterId     string       `json:"cluster_id"`
	Status        string       `json:"status"`
	ErrorCode     *int32       `json:"error_code,omitempty"`
	ErrorMessage  *string      `json:"error_message,omitempty"`
	AnyUnevenLoad Relationship `json:"any_uneven_load"`
	BrokerTasks   Relationship `json:"broker_tasks"`
}

BalancerStatusDataAllOf struct for BalancerStatusDataAllOf

type BalancerStatusV3Api added in v0.3.8

type BalancerStatusV3Api interface {

	/*
	 * ClustersClusterIdBalancerAnyUnevenLoadGet Get AnyUnevenLoad status
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns status of the AnyUnevenLoad for the cluster specified by ``cluster_id``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @return AnyUnevenLoadData
	 */
	ClustersClusterIdBalancerAnyUnevenLoadGet(ctx _context.Context, clusterId string) (AnyUnevenLoadData, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdBalancerGet Get status of the balancer
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  'Returns status about the balancer component for the cluster specified with ``cluster_id``.'
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @return BalancerStatusData
	 */
	ClustersClusterIdBalancerGet(ctx _context.Context, clusterId string) (BalancerStatusData, *_nethttp.Response, error)
}

type BalancerStatusV3ApiService added in v0.3.8

type BalancerStatusV3ApiService service

BalancerStatusV3ApiService BalancerStatusV3Api service

func (*BalancerStatusV3ApiService) ClustersClusterIdBalancerAnyUnevenLoadGet added in v0.3.8

func (a *BalancerStatusV3ApiService) ClustersClusterIdBalancerAnyUnevenLoadGet(ctx _context.Context, clusterId string) (AnyUnevenLoadData, *_nethttp.Response, error)

* ClustersClusterIdBalancerAnyUnevenLoadGet Get AnyUnevenLoad status * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns status of the AnyUnevenLoad for the cluster specified by ``cluster_id``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @return AnyUnevenLoadData

func (*BalancerStatusV3ApiService) ClustersClusterIdBalancerGet added in v0.3.8

func (a *BalancerStatusV3ApiService) ClustersClusterIdBalancerGet(ctx _context.Context, clusterId string) (BalancerStatusData, *_nethttp.Response, error)

* ClustersClusterIdBalancerGet Get status of the balancer * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) 'Returns status about the balancer component for the cluster specified with ``cluster_id``.' * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @return BalancerStatusData

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BrokerApi

type BrokerApi interface {

	/*
	 * ClustersClusterIdBrokersdeletePost Delete several brokers
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param optional nil or *ClustersClusterIdBrokersdeletePostOpts - Optional Parameters:
	 * @param "ShouldShutdown" (optional.Bool) -  To shutdown the broker or not, Default: true
	 * @param "RemoveBrokersRequestData" (optional.Interface of RemoveBrokersRequestData) -  Broker ids to remove
	 * @return BrokerRemovalDataList
	 */
	ClustersClusterIdBrokersdeletePost(ctx _context.Context, clusterId string, localVarOptionals *ClustersClusterIdBrokersdeletePostOpts) (BrokerRemovalDataList, *_nethttp.Response, error)
}

type BrokerApiService

type BrokerApiService service

BrokerApiService BrokerApi service

func (*BrokerApiService) ClustersClusterIdBrokersdeletePost

func (a *BrokerApiService) ClustersClusterIdBrokersdeletePost(ctx _context.Context, clusterId string, localVarOptionals *ClustersClusterIdBrokersdeletePostOpts) (BrokerRemovalDataList, *_nethttp.Response, error)

* ClustersClusterIdBrokersdeletePost Delete several brokers * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param optional nil or *ClustersClusterIdBrokersdeletePostOpts - Optional Parameters: * @param "ShouldShutdown" (optional.Bool) - To shutdown the broker or not, Default: true * @param "RemoveBrokersRequestData" (optional.Interface of RemoveBrokersRequestData) - Broker ids to remove * @return BrokerRemovalDataList

type BrokerConfigData

type BrokerConfigData struct {
	Kind        string              `json:"kind"`
	Metadata    ResourceMetadata    `json:"metadata"`
	ClusterId   string              `json:"cluster_id"`
	Name        string              `json:"name"`
	Value       *string             `json:"value,omitempty"`
	IsDefault   bool                `json:"is_default"`
	IsReadOnly  bool                `json:"is_read_only"`
	IsSensitive bool                `json:"is_sensitive"`
	Source      string              `json:"source"`
	Synonyms    []ConfigSynonymData `json:"synonyms"`
	BrokerId    int32               `json:"broker_id"`
}

BrokerConfigData struct for BrokerConfigData

type BrokerConfigDataAllOf

type BrokerConfigDataAllOf struct {
	BrokerId int32 `json:"broker_id"`
}

BrokerConfigDataAllOf struct for BrokerConfigDataAllOf

type BrokerConfigDataList

type BrokerConfigDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []BrokerConfigData         `json:"data"`
}

BrokerConfigDataList struct for BrokerConfigDataList

type BrokerConfigDataListAllOf

type BrokerConfigDataListAllOf struct {
	Data []BrokerConfigData `json:"data"`
}

BrokerConfigDataListAllOf struct for BrokerConfigDataListAllOf

type BrokerData

type BrokerData struct {
	Kind              string           `json:"kind"`
	Metadata          ResourceMetadata `json:"metadata"`
	ClusterId         string           `json:"cluster_id"`
	BrokerId          int32            `json:"broker_id"`
	Host              *string          `json:"host,omitempty"`
	Port              *int32           `json:"port,omitempty"`
	Rack              *string          `json:"rack,omitempty"`
	Configs           Relationship     `json:"configs"`
	PartitionReplicas Relationship     `json:"partition_replicas"`
}

BrokerData struct for BrokerData

type BrokerDataAllOf

type BrokerDataAllOf struct {
	ClusterId         string       `json:"cluster_id"`
	BrokerId          int32        `json:"broker_id"`
	Host              *string      `json:"host,omitempty"`
	Port              *int32       `json:"port,omitempty"`
	Rack              *string      `json:"rack,omitempty"`
	Configs           Relationship `json:"configs"`
	PartitionReplicas Relationship `json:"partition_replicas"`
}

BrokerDataAllOf struct for BrokerDataAllOf

type BrokerDataList

type BrokerDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []BrokerData               `json:"data"`
}

BrokerDataList struct for BrokerDataList

type BrokerDataListAllOf

type BrokerDataListAllOf struct {
	Data []BrokerData `json:"data"`
}

BrokerDataListAllOf struct for BrokerDataListAllOf

type BrokerRemovalData

type BrokerRemovalData struct {
	Kind       string           `json:"kind"`
	Metadata   ResourceMetadata `json:"metadata"`
	ClusterId  string           `json:"cluster_id"`
	BrokerId   int32            `json:"broker_id"`
	BrokerTask Relationship     `json:"broker_task"`
	Broker     Relationship     `json:"broker"`
}

BrokerRemovalData struct for BrokerRemovalData

type BrokerRemovalDataAllOf

type BrokerRemovalDataAllOf struct {
	ClusterId  string       `json:"cluster_id"`
	BrokerId   int32        `json:"broker_id"`
	BrokerTask Relationship `json:"broker_task"`
	Broker     Relationship `json:"broker"`
}

BrokerRemovalDataAllOf struct for BrokerRemovalDataAllOf

type BrokerRemovalDataList

type BrokerRemovalDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []BrokerRemovalData        `json:"data"`
}

BrokerRemovalDataList struct for BrokerRemovalDataList

type BrokerRemovalDataListAllOf

type BrokerRemovalDataListAllOf struct {
	Data []BrokerRemovalData `json:"data"`
}

BrokerRemovalDataListAllOf struct for BrokerRemovalDataListAllOf

type BrokerReplicaExclusionApi added in v0.3.8

type BrokerReplicaExclusionApi interface {

	/*
	 * ClustersClusterIdBrokerReplicaExclusionsBrokerIdGet Get a Broker Replica Exclusions.
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns a Broker Replica Exclusions in the cluster specified with ``cluster_id`` and broker specified with ``broker_id``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param brokerId The Kafka broker ID.
	 * @return BrokerReplicaExclusionData
	 */
	ClustersClusterIdBrokerReplicaExclusionsBrokerIdGet(ctx _context.Context, clusterId string, brokerId int32) (BrokerReplicaExclusionData, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdBrokerReplicaExclusionsGet Get all Broker Replica Exclusions.
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns all Broker Replica Exclusions in the cluster specified with ``cluster_id``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @return BrokerReplicaExclusionDataList
	 */
	ClustersClusterIdBrokerReplicaExclusionsGet(ctx _context.Context, clusterId string) (BrokerReplicaExclusionDataList, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdBrokerReplicaExclusionscreatePost Create Broker Replica Exclusions
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Create Broker Replica Exclusions for brokers in the cluster specified with ``cluster_id``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param optional nil or *ClustersClusterIdBrokerReplicaExclusionscreatePostOpts - Optional Parameters:
	 * @param "BrokerReplicaExclusionBatchRequestData" (optional.Interface of BrokerReplicaExclusionBatchRequestData) -  Alter Broker Replica Exclusions.
	 * @return AlterBrokerReplicaExclusionDataList
	 */
	ClustersClusterIdBrokerReplicaExclusionscreatePost(ctx _context.Context, clusterId string, localVarOptionals *ClustersClusterIdBrokerReplicaExclusionscreatePostOpts) (AlterBrokerReplicaExclusionDataList, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdBrokerReplicaExclusionsdeletePost Delete Broker Replica Exclusions
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Delete Broker Replica Exclusions for brokers in the cluster specified with ``cluster_id``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param optional nil or *ClustersClusterIdBrokerReplicaExclusionsdeletePostOpts - Optional Parameters:
	 * @param "BrokerReplicaExclusionBatchRequestData" (optional.Interface of BrokerReplicaExclusionBatchRequestData) -  Alter Broker Replica Exclusions.
	 * @return AlterBrokerReplicaExclusionDataList
	 */
	ClustersClusterIdBrokerReplicaExclusionsdeletePost(ctx _context.Context, clusterId string, localVarOptionals *ClustersClusterIdBrokerReplicaExclusionsdeletePostOpts) (AlterBrokerReplicaExclusionDataList, *_nethttp.Response, error)
}

type BrokerReplicaExclusionApiService added in v0.3.8

type BrokerReplicaExclusionApiService service

BrokerReplicaExclusionApiService BrokerReplicaExclusionApi service

func (*BrokerReplicaExclusionApiService) ClustersClusterIdBrokerReplicaExclusionsBrokerIdGet added in v0.3.8

func (a *BrokerReplicaExclusionApiService) ClustersClusterIdBrokerReplicaExclusionsBrokerIdGet(ctx _context.Context, clusterId string, brokerId int32) (BrokerReplicaExclusionData, *_nethttp.Response, error)

* ClustersClusterIdBrokerReplicaExclusionsBrokerIdGet Get a Broker Replica Exclusions. * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns a Broker Replica Exclusions in the cluster specified with ``cluster_id`` and broker specified with ``broker_id``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param brokerId The Kafka broker ID. * @return BrokerReplicaExclusionData

func (*BrokerReplicaExclusionApiService) ClustersClusterIdBrokerReplicaExclusionsGet added in v0.3.8

func (a *BrokerReplicaExclusionApiService) ClustersClusterIdBrokerReplicaExclusionsGet(ctx _context.Context, clusterId string) (BrokerReplicaExclusionDataList, *_nethttp.Response, error)

* ClustersClusterIdBrokerReplicaExclusionsGet Get all Broker Replica Exclusions. * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns all Broker Replica Exclusions in the cluster specified with ``cluster_id``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @return BrokerReplicaExclusionDataList

func (*BrokerReplicaExclusionApiService) ClustersClusterIdBrokerReplicaExclusionscreatePost added in v0.3.8

func (a *BrokerReplicaExclusionApiService) ClustersClusterIdBrokerReplicaExclusionscreatePost(ctx _context.Context, clusterId string, localVarOptionals *ClustersClusterIdBrokerReplicaExclusionscreatePostOpts) (AlterBrokerReplicaExclusionDataList, *_nethttp.Response, error)

* ClustersClusterIdBrokerReplicaExclusionscreatePost Create Broker Replica Exclusions * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Create Broker Replica Exclusions for brokers in the cluster specified with ``cluster_id``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param optional nil or *ClustersClusterIdBrokerReplicaExclusionscreatePostOpts - Optional Parameters: * @param "BrokerReplicaExclusionBatchRequestData" (optional.Interface of BrokerReplicaExclusionBatchRequestData) - Alter Broker Replica Exclusions. * @return AlterBrokerReplicaExclusionDataList

func (*BrokerReplicaExclusionApiService) ClustersClusterIdBrokerReplicaExclusionsdeletePost added in v0.3.8

func (a *BrokerReplicaExclusionApiService) ClustersClusterIdBrokerReplicaExclusionsdeletePost(ctx _context.Context, clusterId string, localVarOptionals *ClustersClusterIdBrokerReplicaExclusionsdeletePostOpts) (AlterBrokerReplicaExclusionDataList, *_nethttp.Response, error)

* ClustersClusterIdBrokerReplicaExclusionsdeletePost Delete Broker Replica Exclusions * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Delete Broker Replica Exclusions for brokers in the cluster specified with ``cluster_id``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param optional nil or *ClustersClusterIdBrokerReplicaExclusionsdeletePostOpts - Optional Parameters: * @param "BrokerReplicaExclusionBatchRequestData" (optional.Interface of BrokerReplicaExclusionBatchRequestData) - Alter Broker Replica Exclusions. * @return AlterBrokerReplicaExclusionDataList

type BrokerReplicaExclusionBatchRequestData added in v0.3.8

type BrokerReplicaExclusionBatchRequestData struct {
	Data []BrokerReplicaExclusionRequestData `json:"data"`
}

BrokerReplicaExclusionBatchRequestData struct for BrokerReplicaExclusionBatchRequestData

type BrokerReplicaExclusionData added in v0.3.8

type BrokerReplicaExclusionData struct {
	Kind      string           `json:"kind"`
	Metadata  ResourceMetadata `json:"metadata"`
	ClusterId string           `json:"cluster_id"`
	BrokerId  int32            `json:"broker_id"`
	Reason    string           `json:"reason"`
	Broker    Relationship     `json:"broker"`
}

BrokerReplicaExclusionData struct for BrokerReplicaExclusionData

type BrokerReplicaExclusionDataAllOf added in v0.3.8

type BrokerReplicaExclusionDataAllOf struct {
	ClusterId string       `json:"cluster_id"`
	BrokerId  int32        `json:"broker_id"`
	Reason    string       `json:"reason"`
	Broker    Relationship `json:"broker"`
}

BrokerReplicaExclusionDataAllOf struct for BrokerReplicaExclusionDataAllOf

type BrokerReplicaExclusionDataList added in v0.3.8

type BrokerReplicaExclusionDataList struct {
	Kind     string                       `json:"kind"`
	Metadata ResourceCollectionMetadata   `json:"metadata"`
	Data     []BrokerReplicaExclusionData `json:"data"`
}

BrokerReplicaExclusionDataList struct for BrokerReplicaExclusionDataList

type BrokerReplicaExclusionDataListAllOf added in v0.3.8

type BrokerReplicaExclusionDataListAllOf struct {
	Data []BrokerReplicaExclusionData `json:"data"`
}

BrokerReplicaExclusionDataListAllOf struct for BrokerReplicaExclusionDataListAllOf

type BrokerReplicaExclusionRequestData added in v0.3.8

type BrokerReplicaExclusionRequestData struct {
	BrokerId int32  `json:"broker_id"`
	Reason   string `json:"reason"`
}

BrokerReplicaExclusionRequestData struct for BrokerReplicaExclusionRequestData

type BrokerTaskApi

type BrokerTaskApi interface {

	/*
	 * ClustersClusterIdBrokersBrokerIdTasksGet List Broker Tasks of a specific Broker
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns a list of all broker tasks for broker specified with ``broker_id`` in the cluster specified with ``cluster_id``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param brokerId The Kafka broker ID.
	 * @return BrokerTaskDataList
	 */
	ClustersClusterIdBrokersBrokerIdTasksGet(ctx _context.Context, clusterId string, brokerId int32) (BrokerTaskDataList, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdBrokersBrokerIdTasksTaskTypeGet Get single Broker Task.
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns a single Broker Task specified with ``task_type`` for broker specified with ``broker_id`` in the cluster specified with ``cluster_id``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param brokerId The Kafka broker ID.
	 * @param taskType The Kafka broker task type.
	 * @return BrokerTaskData
	 */
	ClustersClusterIdBrokersBrokerIdTasksTaskTypeGet(ctx _context.Context, clusterId string, brokerId int32, taskType BrokerTaskType) (BrokerTaskData, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdBrokersTasksGet List Broker Tasks
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns a list of all tasks for all brokers in the cluster specified with ``cluster_id``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @return BrokerTaskDataList
	 */
	ClustersClusterIdBrokersTasksGet(ctx _context.Context, clusterId string) (BrokerTaskDataList, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdBrokersTasksTaskTypeGet List Broker Tasks of a specific TaskType
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns a list of all broker tasks of specified ``task_type`` in the cluster specified with ``cluster_id``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param taskType The Kafka broker task type.
	 * @return BrokerTaskDataList
	 */
	ClustersClusterIdBrokersTasksTaskTypeGet(ctx _context.Context, clusterId string, taskType BrokerTaskType) (BrokerTaskDataList, *_nethttp.Response, error)
}

type BrokerTaskApiService

type BrokerTaskApiService service

BrokerTaskApiService BrokerTaskApi service

func (*BrokerTaskApiService) ClustersClusterIdBrokersBrokerIdTasksGet

func (a *BrokerTaskApiService) ClustersClusterIdBrokersBrokerIdTasksGet(ctx _context.Context, clusterId string, brokerId int32) (BrokerTaskDataList, *_nethttp.Response, error)

* ClustersClusterIdBrokersBrokerIdTasksGet List Broker Tasks of a specific Broker * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns a list of all broker tasks for broker specified with ``broker_id`` in the cluster specified with ``cluster_id``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param brokerId The Kafka broker ID. * @return BrokerTaskDataList

func (*BrokerTaskApiService) ClustersClusterIdBrokersBrokerIdTasksTaskTypeGet

func (a *BrokerTaskApiService) ClustersClusterIdBrokersBrokerIdTasksTaskTypeGet(ctx _context.Context, clusterId string, brokerId int32, taskType BrokerTaskType) (BrokerTaskData, *_nethttp.Response, error)

* ClustersClusterIdBrokersBrokerIdTasksTaskTypeGet Get single Broker Task. * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns a single Broker Task specified with ``task_type`` for broker specified with ``broker_id`` in the cluster specified with ``cluster_id``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param brokerId The Kafka broker ID. * @param taskType The Kafka broker task type. * @return BrokerTaskData

func (*BrokerTaskApiService) ClustersClusterIdBrokersTasksGet

func (a *BrokerTaskApiService) ClustersClusterIdBrokersTasksGet(ctx _context.Context, clusterId string) (BrokerTaskDataList, *_nethttp.Response, error)

* ClustersClusterIdBrokersTasksGet List Broker Tasks * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns a list of all tasks for all brokers in the cluster specified with ``cluster_id``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @return BrokerTaskDataList

func (*BrokerTaskApiService) ClustersClusterIdBrokersTasksTaskTypeGet

func (a *BrokerTaskApiService) ClustersClusterIdBrokersTasksTaskTypeGet(ctx _context.Context, clusterId string, taskType BrokerTaskType) (BrokerTaskDataList, *_nethttp.Response, error)

* ClustersClusterIdBrokersTasksTaskTypeGet List Broker Tasks of a specific TaskType * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns a list of all broker tasks of specified ``task_type`` in the cluster specified with ``cluster_id``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param taskType The Kafka broker task type. * @return BrokerTaskDataList

type BrokerTaskData

type BrokerTaskData struct {
	Kind              string            `json:"kind"`
	Metadata          ResourceMetadata  `json:"metadata"`
	ClusterId         string            `json:"cluster_id"`
	BrokerId          int32             `json:"broker_id"`
	TaskType          BrokerTaskType    `json:"task_type"`
	TaskStatus        string            `json:"task_status"`
	ShutdownScheduled *bool             `json:"shutdown_scheduled,omitempty"`
	SubTaskStatuses   map[string]string `json:"sub_task_statuses"`
	// The date and time at which this task was created.
	CreatedAt time.Time `json:"created_at"`
	// The date and time at which this task was last updated.
	UpdatedAt    time.Time    `json:"updated_at"`
	ErrorCode    *int32       `json:"error_code,omitempty"`
	ErrorMessage *string      `json:"error_message,omitempty"`
	Broker       Relationship `json:"broker"`
}

BrokerTaskData struct for BrokerTaskData

type BrokerTaskDataAllOf

type BrokerTaskDataAllOf struct {
	ClusterId         string            `json:"cluster_id"`
	BrokerId          int32             `json:"broker_id"`
	TaskType          BrokerTaskType    `json:"task_type"`
	TaskStatus        string            `json:"task_status"`
	ShutdownScheduled *bool             `json:"shutdown_scheduled,omitempty"`
	SubTaskStatuses   map[string]string `json:"sub_task_statuses"`
	// The date and time at which this task was created.
	CreatedAt time.Time `json:"created_at"`
	// The date and time at which this task was last updated.
	UpdatedAt    time.Time    `json:"updated_at"`
	ErrorCode    *int32       `json:"error_code,omitempty"`
	ErrorMessage *string      `json:"error_message,omitempty"`
	Broker       Relationship `json:"broker"`
}

BrokerTaskDataAllOf struct for BrokerTaskDataAllOf

type BrokerTaskDataList

type BrokerTaskDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []BrokerTaskData           `json:"data"`
}

BrokerTaskDataList struct for BrokerTaskDataList

type BrokerTaskDataListAllOf

type BrokerTaskDataListAllOf struct {
	Data []BrokerTaskData `json:"data"`
}

BrokerTaskDataListAllOf struct for BrokerTaskDataListAllOf

type BrokerTaskType

type BrokerTaskType string

BrokerTaskType the model 'BrokerTaskType'

const (
	BROKERTASKTYPE_ADD_BROKER    BrokerTaskType = "add-broker"
	BROKERTASKTYPE_REMOVE_BROKER BrokerTaskType = "remove-broker"
)

List of BrokerTaskType

type BrokerV3Api added in v0.3.8

type BrokerV3Api interface {

	/*
	 * ClustersClusterIdBrokersBrokerIdDelete Delete Broker
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Deletes the broker that is specified by ``broker_id``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param brokerId The Kafka broker ID.
	 * @param optional nil or *ClustersClusterIdBrokersBrokerIdDeleteOpts - Optional Parameters:
	 * @param "ShouldShutdown" (optional.Bool) -  To shutdown the broker or not, Default: true
	 * @return BrokerRemovalData
	 */
	ClustersClusterIdBrokersBrokerIdDelete(ctx _context.Context, clusterId string, brokerId int32, localVarOptionals *ClustersClusterIdBrokersBrokerIdDeleteOpts) (BrokerRemovalData, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdBrokersBrokerIdGet Get Broker
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns the broker specified by ``broker_id``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param brokerId The Kafka broker ID.
	 * @return BrokerData
	 */
	ClustersClusterIdBrokersBrokerIdGet(ctx _context.Context, clusterId string, brokerId int32) (BrokerData, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdBrokersBrokerIdPartitionReplicasGet Search Replicas by Broker
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns the list of replicas assigned to the specified broker.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param brokerId The Kafka broker ID.
	 * @return ReplicaDataList
	 */
	ClustersClusterIdBrokersBrokerIdPartitionReplicasGet(ctx _context.Context, clusterId string, brokerId int32) (ReplicaDataList, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdBrokersGet List Brokers
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Return a list of brokers that belong to the specified Kafka cluster.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @return BrokerDataList
	 */
	ClustersClusterIdBrokersGet(ctx _context.Context, clusterId string) (BrokerDataList, *_nethttp.Response, error)
}

type BrokerV3ApiService added in v0.3.8

type BrokerV3ApiService service

BrokerV3ApiService BrokerV3Api service

func (*BrokerV3ApiService) ClustersClusterIdBrokersBrokerIdDelete added in v0.3.8

func (a *BrokerV3ApiService) ClustersClusterIdBrokersBrokerIdDelete(ctx _context.Context, clusterId string, brokerId int32, localVarOptionals *ClustersClusterIdBrokersBrokerIdDeleteOpts) (BrokerRemovalData, *_nethttp.Response, error)

* ClustersClusterIdBrokersBrokerIdDelete Delete Broker * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Deletes the broker that is specified by ``broker_id``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param brokerId The Kafka broker ID. * @param optional nil or *ClustersClusterIdBrokersBrokerIdDeleteOpts - Optional Parameters: * @param "ShouldShutdown" (optional.Bool) - To shutdown the broker or not, Default: true * @return BrokerRemovalData

func (*BrokerV3ApiService) ClustersClusterIdBrokersBrokerIdGet added in v0.3.8

func (a *BrokerV3ApiService) ClustersClusterIdBrokersBrokerIdGet(ctx _context.Context, clusterId string, brokerId int32) (BrokerData, *_nethttp.Response, error)

* ClustersClusterIdBrokersBrokerIdGet Get Broker * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the broker specified by ``broker_id``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param brokerId The Kafka broker ID. * @return BrokerData

func (*BrokerV3ApiService) ClustersClusterIdBrokersBrokerIdPartitionReplicasGet added in v0.3.8

func (a *BrokerV3ApiService) ClustersClusterIdBrokersBrokerIdPartitionReplicasGet(ctx _context.Context, clusterId string, brokerId int32) (ReplicaDataList, *_nethttp.Response, error)

* ClustersClusterIdBrokersBrokerIdPartitionReplicasGet Search Replicas by Broker * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the list of replicas assigned to the specified broker. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param brokerId The Kafka broker ID. * @return ReplicaDataList

func (*BrokerV3ApiService) ClustersClusterIdBrokersGet added in v0.3.8

func (a *BrokerV3ApiService) ClustersClusterIdBrokersGet(ctx _context.Context, clusterId string) (BrokerDataList, *_nethttp.Response, error)

* ClustersClusterIdBrokersGet List Brokers * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return a list of brokers that belong to the specified Kafka cluster. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @return BrokerDataList

type ClusterConfigData

type ClusterConfigData struct {
	Kind        string              `json:"kind"`
	Metadata    ResourceMetadata    `json:"metadata"`
	ClusterId   string              `json:"cluster_id"`
	Name        string              `json:"name"`
	Value       *string             `json:"value,omitempty"`
	IsDefault   bool                `json:"is_default"`
	IsReadOnly  bool                `json:"is_read_only"`
	IsSensitive bool                `json:"is_sensitive"`
	Source      string              `json:"source"`
	Synonyms    []ConfigSynonymData `json:"synonyms"`
	ConfigType  string              `json:"config_type"`
}

ClusterConfigData struct for ClusterConfigData

type ClusterConfigDataAllOf

type ClusterConfigDataAllOf struct {
	ConfigType string `json:"config_type"`
}

ClusterConfigDataAllOf struct for ClusterConfigDataAllOf

type ClusterConfigDataList

type ClusterConfigDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []ClusterConfigData        `json:"data"`
}

ClusterConfigDataList struct for ClusterConfigDataList

type ClusterConfigDataListAllOf

type ClusterConfigDataListAllOf struct {
	Data []ClusterConfigData `json:"data"`
}

ClusterConfigDataListAllOf struct for ClusterConfigDataListAllOf

type ClusterData

type ClusterData struct {
	Kind                   string           `json:"kind"`
	Metadata               ResourceMetadata `json:"metadata"`
	ClusterId              string           `json:"cluster_id"`
	Controller             Relationship     `json:"controller,omitempty"`
	Acls                   Relationship     `json:"acls"`
	Brokers                Relationship     `json:"brokers"`
	BrokerConfigs          Relationship     `json:"broker_configs"`
	ConsumerGroups         Relationship     `json:"consumer_groups"`
	Topics                 Relationship     `json:"topics"`
	PartitionReassignments Relationship     `json:"partition_reassignments"`
}

ClusterData struct for ClusterData

type ClusterDataAllOf

type ClusterDataAllOf struct {
	ClusterId              string       `json:"cluster_id"`
	Controller             Relationship `json:"controller,omitempty"`
	Acls                   Relationship `json:"acls"`
	Brokers                Relationship `json:"brokers"`
	BrokerConfigs          Relationship `json:"broker_configs"`
	ConsumerGroups         Relationship `json:"consumer_groups"`
	Topics                 Relationship `json:"topics"`
	PartitionReassignments Relationship `json:"partition_reassignments"`
}

ClusterDataAllOf struct for ClusterDataAllOf

type ClusterDataList

type ClusterDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []ClusterData              `json:"data"`
}

ClusterDataList struct for ClusterDataList

type ClusterDataListAllOf

type ClusterDataListAllOf struct {
	Data []ClusterData `json:"data"`
}

ClusterDataListAllOf struct for ClusterDataListAllOf

type ClusterLinkingV3Api added in v0.3.8

type ClusterLinkingV3Api interface {

	/*
	 * CreateKafkaLink Create a cluster link
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Cluster link creation requires source cluster security configurations in the configs JSON section of the data request payload.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param linkName The link name
	 * @param optional nil or *CreateKafkaLinkOpts - Optional Parameters:
	 * @param "ValidateOnly" (optional.Bool) -  To validate the action can be performed successfully or not. Default: false
	 * @param "ValidateLink" (optional.Bool) -  To synchronously validate that the source cluster ID is expected and the dest cluster has the permission to read topics in the source cluster. Default: true
	 * @param "CreateLinkRequestData" (optional.Interface of CreateLinkRequestData) -  Create a cluster link
	 */
	CreateKafkaLink(ctx _context.Context, clusterId string, linkName string, localVarOptionals *CreateKafkaLinkOpts) (*_nethttp.Response, error)

	/*
	 * CreateKafkaMirrorTopic Create a mirror topic
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Create a topic in the destination cluster mirroring a topic in the source cluster
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param linkName The link name
	 * @param optional nil or *CreateKafkaMirrorTopicOpts - Optional Parameters:
	 * @param "CreateMirrorTopicRequestData" (optional.Interface of CreateMirrorTopicRequestData) -  Name and configs of the topics mirroring from and mirroring to
	 */
	CreateKafkaMirrorTopic(ctx _context.Context, clusterId string, linkName string, localVarOptionals *CreateKafkaMirrorTopicOpts) (*_nethttp.Response, error)

	/*
	 * DeleteKafkaLink Delete the cluster link
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param linkName The link name
	 * @param optional nil or *DeleteKafkaLinkOpts - Optional Parameters:
	 * @param "Force" (optional.Bool) -  Force the action. Default: false
	 * @param "ValidateOnly" (optional.Bool) -  To validate the action can be performed successfully or not. Default: false
	 */
	DeleteKafkaLink(ctx _context.Context, clusterId string, linkName string, localVarOptionals *DeleteKafkaLinkOpts) (*_nethttp.Response, error)

	/*
	 * DeleteKafkaLinkConfig Reset the given config to default value
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param linkName The link name
	 * @param configName The link config name
	 */
	DeleteKafkaLinkConfig(ctx _context.Context, clusterId string, linkName string, configName string) (*_nethttp.Response, error)

	/*
	 * GetKafkaLink Describe the cluster link
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  ``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param linkName The link name
	 * @param optional nil or *GetKafkaLinkOpts - Optional Parameters:
	 * @param "IncludeTasks" (optional.Bool) -  Whether to include cluster linking tasks in the response. Default: false
	 * @return ListLinksResponseData
	 */
	GetKafkaLink(ctx _context.Context, clusterId string, linkName string, localVarOptionals *GetKafkaLinkOpts) (ListLinksResponseData, *_nethttp.Response, error)

	/*
	 * GetKafkaLinkConfigs Describe the config under the cluster link
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param linkName The link name
	 * @param configName The link config name
	 * @return ListLinkConfigsResponseData
	 */
	GetKafkaLinkConfigs(ctx _context.Context, clusterId string, linkName string, configName string) (ListLinkConfigsResponseData, *_nethttp.Response, error)

	/*
	 * ListKafkaLinkConfigs List all configs of the cluster link
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param linkName The link name
	 * @return ListLinkConfigsResponseDataList
	 */
	ListKafkaLinkConfigs(ctx _context.Context, clusterId string, linkName string) (ListLinkConfigsResponseDataList, *_nethttp.Response, error)

	/*
	 * ListKafkaLinks List all cluster links in the dest cluster
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  ``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @return ListLinksResponseDataList
	 */
	ListKafkaLinks(ctx _context.Context, clusterId string) (ListLinksResponseDataList, *_nethttp.Response, error)

	/*
	 * ListKafkaMirrorTopics List mirror topics
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  List all mirror topics in the cluster
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param optional nil or *ListKafkaMirrorTopicsOpts - Optional Parameters:
	 * @param "MirrorStatus" (optional.Interface of MirrorTopicStatus) -  The status of the mirror topic. If not specified, all mirror topics will be returned.
	 * @return ListMirrorTopicsResponseDataList
	 */
	ListKafkaMirrorTopics(ctx _context.Context, clusterId string, localVarOptionals *ListKafkaMirrorTopicsOpts) (ListMirrorTopicsResponseDataList, *_nethttp.Response, error)

	/*
	 * ListKafkaMirrorTopicsUnderLink List mirror topics
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  List all mirror topics under the link
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param linkName The link name
	 * @param optional nil or *ListKafkaMirrorTopicsUnderLinkOpts - Optional Parameters:
	 * @param "MirrorStatus" (optional.Interface of MirrorTopicStatus) -  The status of the mirror topic. If not specified, all mirror topics will be returned.
	 * @return ListMirrorTopicsResponseDataList
	 */
	ListKafkaMirrorTopicsUnderLink(ctx _context.Context, clusterId string, linkName string, localVarOptionals *ListKafkaMirrorTopicsUnderLinkOpts) (ListMirrorTopicsResponseDataList, *_nethttp.Response, error)

	/*
	 * ReadKafkaMirrorTopic Describe the mirror topic
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param linkName The link name
	 * @param mirrorTopicName Cluster Linking mirror topic name
	 * @param optional nil or *ReadKafkaMirrorTopicOpts - Optional Parameters:
	 * @param "IncludeStateTransitionErrors" (optional.Bool) -  Whether to include mirror state transition errors in the response. Default: false
	 * @return ListMirrorTopicsResponseData
	 */
	ReadKafkaMirrorTopic(ctx _context.Context, clusterId string, linkName string, mirrorTopicName string, localVarOptionals *ReadKafkaMirrorTopicOpts) (ListMirrorTopicsResponseData, *_nethttp.Response, error)

	/*
	 * UpdateKafkaLinkConfig Alter the config under the cluster link
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param linkName The link name
	 * @param configName The link config name
	 * @param optional nil or *UpdateKafkaLinkConfigOpts - Optional Parameters:
	 * @param "UpdateLinkConfigRequestData" (optional.Interface of UpdateLinkConfigRequestData) -  Link config value to update
	 */
	UpdateKafkaLinkConfig(ctx _context.Context, clusterId string, linkName string, configName string, localVarOptionals *UpdateKafkaLinkConfigOpts) (*_nethttp.Response, error)

	/*
	 * UpdateKafkaLinkConfigBatch Batch Alter Cluster Link Configs
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Batch Alter Cluster Link Configs
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param linkName The link name
	 * @param optional nil or *UpdateKafkaLinkConfigBatchOpts - Optional Parameters:
	 * @param "ValidateOnly" (optional.Bool) -  To validate the action can be performed successfully or not. Default: false
	 * @param "AlterConfigBatchRequestData" (optional.Interface of AlterConfigBatchRequestData) -
	 */
	UpdateKafkaLinkConfigBatch(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaLinkConfigBatchOpts) (*_nethttp.Response, error)

	/*
	 * UpdateKafkaMirrorTopicsFailover Failover the mirror topics
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param linkName The link name
	 * @param optional nil or *UpdateKafkaMirrorTopicsFailoverOpts - Optional Parameters:
	 * @param "ValidateOnly" (optional.Bool) -  To validate the action can be performed successfully or not. Default: false
	 * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) -  Mirror topics to be altered.
	 * @return AlterMirrorStatusResponseDataList
	 */
	UpdateKafkaMirrorTopicsFailover(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaMirrorTopicsFailoverOpts) (AlterMirrorStatusResponseDataList, *_nethttp.Response, error)

	/*
	 * UpdateKafkaMirrorTopicsPause Pause the mirror topics
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param linkName The link name
	 * @param optional nil or *UpdateKafkaMirrorTopicsPauseOpts - Optional Parameters:
	 * @param "ValidateOnly" (optional.Bool) -  To validate the action can be performed successfully or not. Default: false
	 * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) -  Mirror topics to be altered.
	 * @return AlterMirrorStatusResponseDataList
	 */
	UpdateKafkaMirrorTopicsPause(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaMirrorTopicsPauseOpts) (AlterMirrorStatusResponseDataList, *_nethttp.Response, error)

	/*
	 * UpdateKafkaMirrorTopicsPromote Promote the mirror topics
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param linkName The link name
	 * @param optional nil or *UpdateKafkaMirrorTopicsPromoteOpts - Optional Parameters:
	 * @param "ValidateOnly" (optional.Bool) -  To validate the action can be performed successfully or not. Default: false
	 * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) -  Mirror topics to be altered.
	 * @return AlterMirrorStatusResponseDataList
	 */
	UpdateKafkaMirrorTopicsPromote(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaMirrorTopicsPromoteOpts) (AlterMirrorStatusResponseDataList, *_nethttp.Response, error)

	/*
	 * UpdateKafkaMirrorTopicsResume Resume the mirror topics
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param linkName The link name
	 * @param optional nil or *UpdateKafkaMirrorTopicsResumeOpts - Optional Parameters:
	 * @param "ValidateOnly" (optional.Bool) -  To validate the action can be performed successfully or not. Default: false
	 * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) -  Mirror topics to be altered.
	 * @return AlterMirrorStatusResponseDataList
	 */
	UpdateKafkaMirrorTopicsResume(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaMirrorTopicsResumeOpts) (AlterMirrorStatusResponseDataList, *_nethttp.Response, error)

	/*
	 * UpdateKafkaMirrorTopicsReverseAndPauseMirror Reverse local mirror topic and pause the remote mirror topic
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param linkName The link name
	 * @param optional nil or *UpdateKafkaMirrorTopicsReverseAndPauseMirrorOpts - Optional Parameters:
	 * @param "ValidateOnly" (optional.Bool) -  To validate the action can be performed successfully or not. Default: false
	 * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) -  Mirror topics to be altered.
	 * @return AlterMirrorStatusResponseDataList
	 */
	UpdateKafkaMirrorTopicsReverseAndPauseMirror(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaMirrorTopicsReverseAndPauseMirrorOpts) (AlterMirrorStatusResponseDataList, *_nethttp.Response, error)

	/*
	 * UpdateKafkaMirrorTopicsReverseAndStarMirror Reverse local mirror topic and start the remote mirror topic
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param linkName The link name
	 * @param optional nil or *UpdateKafkaMirrorTopicsReverseAndStarMirrorOpts - Optional Parameters:
	 * @param "ValidateOnly" (optional.Bool) -  To validate the action can be performed successfully or not. Default: false
	 * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) -  Mirror topics to be altered.
	 * @return AlterMirrorStatusResponseDataList
	 */
	UpdateKafkaMirrorTopicsReverseAndStarMirror(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaMirrorTopicsReverseAndStarMirrorOpts) (AlterMirrorStatusResponseDataList, *_nethttp.Response, error)
}

type ClusterLinkingV3ApiService added in v0.3.8

type ClusterLinkingV3ApiService service

ClusterLinkingV3ApiService ClusterLinkingV3Api service

func (a *ClusterLinkingV3ApiService) CreateKafkaLink(ctx _context.Context, clusterId string, linkName string, localVarOptionals *CreateKafkaLinkOpts) (*_nethttp.Response, error)

* CreateKafkaLink Create a cluster link * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Cluster link creation requires source cluster security configurations in the configs JSON section of the data request payload. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param linkName The link name * @param optional nil or *CreateKafkaLinkOpts - Optional Parameters: * @param "ValidateOnly" (optional.Bool) - To validate the action can be performed successfully or not. Default: false * @param "ValidateLink" (optional.Bool) - To synchronously validate that the source cluster ID is expected and the dest cluster has the permission to read topics in the source cluster. Default: true * @param "CreateLinkRequestData" (optional.Interface of CreateLinkRequestData) - Create a cluster link

func (*ClusterLinkingV3ApiService) CreateKafkaMirrorTopic added in v0.3.8

func (a *ClusterLinkingV3ApiService) CreateKafkaMirrorTopic(ctx _context.Context, clusterId string, linkName string, localVarOptionals *CreateKafkaMirrorTopicOpts) (*_nethttp.Response, error)

* CreateKafkaMirrorTopic Create a mirror topic * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Create a topic in the destination cluster mirroring a topic in the source cluster * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param linkName The link name * @param optional nil or *CreateKafkaMirrorTopicOpts - Optional Parameters: * @param "CreateMirrorTopicRequestData" (optional.Interface of CreateMirrorTopicRequestData) - Name and configs of the topics mirroring from and mirroring to

func (a *ClusterLinkingV3ApiService) DeleteKafkaLink(ctx _context.Context, clusterId string, linkName string, localVarOptionals *DeleteKafkaLinkOpts) (*_nethttp.Response, error)

* DeleteKafkaLink Delete the cluster link * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param linkName The link name * @param optional nil or *DeleteKafkaLinkOpts - Optional Parameters: * @param "Force" (optional.Bool) - Force the action. Default: false * @param "ValidateOnly" (optional.Bool) - To validate the action can be performed successfully or not. Default: false

func (*ClusterLinkingV3ApiService) DeleteKafkaLinkConfig added in v0.3.8

func (a *ClusterLinkingV3ApiService) DeleteKafkaLinkConfig(ctx _context.Context, clusterId string, linkName string, configName string) (*_nethttp.Response, error)

* DeleteKafkaLinkConfig Reset the given config to default value * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param linkName The link name * @param configName The link config name

func (a *ClusterLinkingV3ApiService) GetKafkaLink(ctx _context.Context, clusterId string, linkName string, localVarOptionals *GetKafkaLinkOpts) (ListLinksResponseData, *_nethttp.Response, error)

* GetKafkaLink Describe the cluster link * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) ``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param linkName The link name * @param optional nil or *GetKafkaLinkOpts - Optional Parameters: * @param "IncludeTasks" (optional.Bool) - Whether to include cluster linking tasks in the response. Default: false * @return ListLinksResponseData

func (*ClusterLinkingV3ApiService) GetKafkaLinkConfigs added in v0.3.8

func (a *ClusterLinkingV3ApiService) GetKafkaLinkConfigs(ctx _context.Context, clusterId string, linkName string, configName string) (ListLinkConfigsResponseData, *_nethttp.Response, error)

* GetKafkaLinkConfigs Describe the config under the cluster link * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param linkName The link name * @param configName The link config name * @return ListLinkConfigsResponseData

func (*ClusterLinkingV3ApiService) ListKafkaLinkConfigs added in v0.3.8

func (a *ClusterLinkingV3ApiService) ListKafkaLinkConfigs(ctx _context.Context, clusterId string, linkName string) (ListLinkConfigsResponseDataList, *_nethttp.Response, error)

* ListKafkaLinkConfigs List all configs of the cluster link * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param linkName The link name * @return ListLinkConfigsResponseDataList

* ListKafkaLinks List all cluster links in the dest cluster * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) ``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @return ListLinksResponseDataList

func (*ClusterLinkingV3ApiService) ListKafkaMirrorTopics added in v0.3.8

* ListKafkaMirrorTopics List mirror topics * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) List all mirror topics in the cluster * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param optional nil or *ListKafkaMirrorTopicsOpts - Optional Parameters: * @param "MirrorStatus" (optional.Interface of MirrorTopicStatus) - The status of the mirror topic. If not specified, all mirror topics will be returned. * @return ListMirrorTopicsResponseDataList

func (a *ClusterLinkingV3ApiService) ListKafkaMirrorTopicsUnderLink(ctx _context.Context, clusterId string, linkName string, localVarOptionals *ListKafkaMirrorTopicsUnderLinkOpts) (ListMirrorTopicsResponseDataList, *_nethttp.Response, error)

* ListKafkaMirrorTopicsUnderLink List mirror topics * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) List all mirror topics under the link * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param linkName The link name * @param optional nil or *ListKafkaMirrorTopicsUnderLinkOpts - Optional Parameters: * @param "MirrorStatus" (optional.Interface of MirrorTopicStatus) - The status of the mirror topic. If not specified, all mirror topics will be returned. * @return ListMirrorTopicsResponseDataList

func (*ClusterLinkingV3ApiService) ReadKafkaMirrorTopic added in v0.3.8

func (a *ClusterLinkingV3ApiService) ReadKafkaMirrorTopic(ctx _context.Context, clusterId string, linkName string, mirrorTopicName string, localVarOptionals *ReadKafkaMirrorTopicOpts) (ListMirrorTopicsResponseData, *_nethttp.Response, error)

* ReadKafkaMirrorTopic Describe the mirror topic * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param linkName The link name * @param mirrorTopicName Cluster Linking mirror topic name * @param optional nil or *ReadKafkaMirrorTopicOpts - Optional Parameters: * @param "IncludeStateTransitionErrors" (optional.Bool) - Whether to include mirror state transition errors in the response. Default: false * @return ListMirrorTopicsResponseData

func (*ClusterLinkingV3ApiService) UpdateKafkaLinkConfig added in v0.3.8

func (a *ClusterLinkingV3ApiService) UpdateKafkaLinkConfig(ctx _context.Context, clusterId string, linkName string, configName string, localVarOptionals *UpdateKafkaLinkConfigOpts) (*_nethttp.Response, error)

* UpdateKafkaLinkConfig Alter the config under the cluster link * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param linkName The link name * @param configName The link config name * @param optional nil or *UpdateKafkaLinkConfigOpts - Optional Parameters: * @param "UpdateLinkConfigRequestData" (optional.Interface of UpdateLinkConfigRequestData) - Link config value to update

func (*ClusterLinkingV3ApiService) UpdateKafkaLinkConfigBatch added in v0.3.8

func (a *ClusterLinkingV3ApiService) UpdateKafkaLinkConfigBatch(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaLinkConfigBatchOpts) (*_nethttp.Response, error)

* UpdateKafkaLinkConfigBatch Batch Alter Cluster Link Configs * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Batch Alter Cluster Link Configs * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param linkName The link name * @param optional nil or *UpdateKafkaLinkConfigBatchOpts - Optional Parameters: * @param "ValidateOnly" (optional.Bool) - To validate the action can be performed successfully or not. Default: false * @param "AlterConfigBatchRequestData" (optional.Interface of AlterConfigBatchRequestData) -

func (*ClusterLinkingV3ApiService) UpdateKafkaMirrorTopicsFailover added in v0.3.8

func (a *ClusterLinkingV3ApiService) UpdateKafkaMirrorTopicsFailover(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaMirrorTopicsFailoverOpts) (AlterMirrorStatusResponseDataList, *_nethttp.Response, error)

* UpdateKafkaMirrorTopicsFailover Failover the mirror topics * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param linkName The link name * @param optional nil or *UpdateKafkaMirrorTopicsFailoverOpts - Optional Parameters: * @param "ValidateOnly" (optional.Bool) - To validate the action can be performed successfully or not. Default: false * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) - Mirror topics to be altered. * @return AlterMirrorStatusResponseDataList

func (*ClusterLinkingV3ApiService) UpdateKafkaMirrorTopicsPause added in v0.3.8

func (a *ClusterLinkingV3ApiService) UpdateKafkaMirrorTopicsPause(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaMirrorTopicsPauseOpts) (AlterMirrorStatusResponseDataList, *_nethttp.Response, error)

* UpdateKafkaMirrorTopicsPause Pause the mirror topics * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param linkName The link name * @param optional nil or *UpdateKafkaMirrorTopicsPauseOpts - Optional Parameters: * @param "ValidateOnly" (optional.Bool) - To validate the action can be performed successfully or not. Default: false * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) - Mirror topics to be altered. * @return AlterMirrorStatusResponseDataList

func (*ClusterLinkingV3ApiService) UpdateKafkaMirrorTopicsPromote added in v0.3.8

func (a *ClusterLinkingV3ApiService) UpdateKafkaMirrorTopicsPromote(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaMirrorTopicsPromoteOpts) (AlterMirrorStatusResponseDataList, *_nethttp.Response, error)

* UpdateKafkaMirrorTopicsPromote Promote the mirror topics * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param linkName The link name * @param optional nil or *UpdateKafkaMirrorTopicsPromoteOpts - Optional Parameters: * @param "ValidateOnly" (optional.Bool) - To validate the action can be performed successfully or not. Default: false * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) - Mirror topics to be altered. * @return AlterMirrorStatusResponseDataList

func (*ClusterLinkingV3ApiService) UpdateKafkaMirrorTopicsResume added in v0.3.8

func (a *ClusterLinkingV3ApiService) UpdateKafkaMirrorTopicsResume(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaMirrorTopicsResumeOpts) (AlterMirrorStatusResponseDataList, *_nethttp.Response, error)

* UpdateKafkaMirrorTopicsResume Resume the mirror topics * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param linkName The link name * @param optional nil or *UpdateKafkaMirrorTopicsResumeOpts - Optional Parameters: * @param "ValidateOnly" (optional.Bool) - To validate the action can be performed successfully or not. Default: false * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) - Mirror topics to be altered. * @return AlterMirrorStatusResponseDataList

func (*ClusterLinkingV3ApiService) UpdateKafkaMirrorTopicsReverseAndPauseMirror added in v0.3.18

func (a *ClusterLinkingV3ApiService) UpdateKafkaMirrorTopicsReverseAndPauseMirror(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaMirrorTopicsReverseAndPauseMirrorOpts) (AlterMirrorStatusResponseDataList, *_nethttp.Response, error)

* UpdateKafkaMirrorTopicsReverseAndPauseMirror Reverse local mirror topic and pause the remote mirror topic * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param linkName The link name * @param optional nil or *UpdateKafkaMirrorTopicsReverseAndPauseMirrorOpts - Optional Parameters: * @param "ValidateOnly" (optional.Bool) - To validate the action can be performed successfully or not. Default: false * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) - Mirror topics to be altered. * @return AlterMirrorStatusResponseDataList

func (*ClusterLinkingV3ApiService) UpdateKafkaMirrorTopicsReverseAndStarMirror added in v0.3.18

func (a *ClusterLinkingV3ApiService) UpdateKafkaMirrorTopicsReverseAndStarMirror(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaMirrorTopicsReverseAndStarMirrorOpts) (AlterMirrorStatusResponseDataList, *_nethttp.Response, error)

* UpdateKafkaMirrorTopicsReverseAndStarMirror Reverse local mirror topic and start the remote mirror topic * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param linkName The link name * @param optional nil or *UpdateKafkaMirrorTopicsReverseAndStarMirrorOpts - Optional Parameters: * @param "ValidateOnly" (optional.Bool) - To validate the action can be performed successfully or not. Default: false * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) - Mirror topics to be altered. * @return AlterMirrorStatusResponseDataList

type ClusterV3Api added in v0.3.8

type ClusterV3Api interface {

	/*
	 * ClustersGet List Clusters
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  'Returns a list of known Kafka clusters. Currently both Kafka and Kafka REST Proxy are only aware of the Kafka cluster pointed at by the ``bootstrap.servers`` configuration. Therefore only one Kafka cluster will be returned in the response.'
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return ClusterDataList
	 */
	ClustersGet(ctx _context.Context) (ClusterDataList, *_nethttp.Response, error)

	/*
	 * GetKafkaCluster Get Cluster
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns the Kafka cluster with the specified ``cluster_id``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @return ClusterData
	 */
	GetKafkaCluster(ctx _context.Context, clusterId string) (ClusterData, *_nethttp.Response, error)
}

type ClusterV3ApiService added in v0.3.8

type ClusterV3ApiService service

ClusterV3ApiService ClusterV3Api service

func (*ClusterV3ApiService) ClustersGet added in v0.3.8

* ClustersGet List Clusters * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) 'Returns a list of known Kafka clusters. Currently both Kafka and Kafka REST Proxy are only aware of the Kafka cluster pointed at by the ``bootstrap.servers`` configuration. Therefore only one Kafka cluster will be returned in the response.' * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return ClusterDataList

func (*ClusterV3ApiService) GetKafkaCluster added in v0.3.8

func (a *ClusterV3ApiService) GetKafkaCluster(ctx _context.Context, clusterId string) (ClusterData, *_nethttp.Response, error)

* GetKafkaCluster Get Cluster * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the Kafka cluster with the specified ``cluster_id``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @return ClusterData

type ClustersClusterIdBrokerReplicaExclusionscreatePostOpts added in v0.3.8

type ClustersClusterIdBrokerReplicaExclusionscreatePostOpts struct {
	BrokerReplicaExclusionBatchRequestData optional.Interface
}

ClustersClusterIdBrokerReplicaExclusionscreatePostOpts Optional parameters for the method 'ClustersClusterIdBrokerReplicaExclusionscreatePost'

type ClustersClusterIdBrokerReplicaExclusionsdeletePostOpts added in v0.3.8

type ClustersClusterIdBrokerReplicaExclusionsdeletePostOpts struct {
	BrokerReplicaExclusionBatchRequestData optional.Interface
}

ClustersClusterIdBrokerReplicaExclusionsdeletePostOpts Optional parameters for the method 'ClustersClusterIdBrokerReplicaExclusionsdeletePost'

type ClustersClusterIdBrokersBrokerIdConfigsNamePutOpts

type ClustersClusterIdBrokersBrokerIdConfigsNamePutOpts struct {
	UpdateConfigRequestData optional.Interface
}

ClustersClusterIdBrokersBrokerIdConfigsNamePutOpts Optional parameters for the method 'ClustersClusterIdBrokersBrokerIdConfigsNamePut'

type ClustersClusterIdBrokersBrokerIdConfigsalterPostOpts

type ClustersClusterIdBrokersBrokerIdConfigsalterPostOpts struct {
	AlterConfigBatchRequestData optional.Interface
}

ClustersClusterIdBrokersBrokerIdConfigsalterPostOpts Optional parameters for the method 'ClustersClusterIdBrokersBrokerIdConfigsalterPost'

type ClustersClusterIdBrokersBrokerIdDeleteOpts

type ClustersClusterIdBrokersBrokerIdDeleteOpts struct {
	ShouldShutdown optional.Bool
}

ClustersClusterIdBrokersBrokerIdDeleteOpts Optional parameters for the method 'ClustersClusterIdBrokersBrokerIdDelete'

type ClustersClusterIdBrokersdeletePostOpts

type ClustersClusterIdBrokersdeletePostOpts struct {
	ShouldShutdown           optional.Bool
	RemoveBrokersRequestData optional.Interface
}

ClustersClusterIdBrokersdeletePostOpts Optional parameters for the method 'ClustersClusterIdBrokersdeletePost'

type ClustersClusterIdTopicsTopicNameRecordsPostOpts added in v0.3.8

type ClustersClusterIdTopicsTopicNameRecordsPostOpts struct {
	ProduceRequest optional.Interface
}

ClustersClusterIdTopicsTopicNameRecordsPostOpts Optional parameters for the method 'ClustersClusterIdTopicsTopicNameRecordsPost'

type ConfigData

type ConfigData struct {
	Name  string  `json:"name"`
	Value *string `json:"value"`
}

ConfigData struct for ConfigData

type ConfigSynonymData

type ConfigSynonymData struct {
	Name   string  `json:"name"`
	Value  *string `json:"value,omitempty"`
	Source string  `json:"source"`
}

ConfigSynonymData struct for ConfigSynonymData

type ConfigsV3Api added in v0.3.8

type ConfigsV3Api interface {

	/*
	 * ClustersClusterIdBrokersBrokerIdConfigsGet List Broker Configs
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Return the list of configuration parameters that belong to the specified Kafka broker.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param brokerId The Kafka broker ID.
	 * @return BrokerConfigDataList
	 */
	ClustersClusterIdBrokersBrokerIdConfigsGet(ctx _context.Context, clusterId string, brokerId int32) (BrokerConfigDataList, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdBrokersBrokerIdConfigsNameDelete Reset Broker Config
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Resets the configuration parameter specified by ``name`` to its default value.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param brokerId The Kafka broker ID.
	 * @param name The configuration parameter name.
	 */
	ClustersClusterIdBrokersBrokerIdConfigsNameDelete(ctx _context.Context, clusterId string, brokerId int32, name string) (*_nethttp.Response, error)

	/*
	 * ClustersClusterIdBrokersBrokerIdConfigsNameGet Get Broker Config
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Return the configuration parameter specified by ``name``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param brokerId The Kafka broker ID.
	 * @param name The configuration parameter name.
	 * @return BrokerConfigData
	 */
	ClustersClusterIdBrokersBrokerIdConfigsNameGet(ctx _context.Context, clusterId string, brokerId int32, name string) (BrokerConfigData, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdBrokersBrokerIdConfigsNamePut Update Broker Config
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Updates the configuration parameter specified by ``name``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param brokerId The Kafka broker ID.
	 * @param name The configuration parameter name.
	 * @param optional nil or *ClustersClusterIdBrokersBrokerIdConfigsNamePutOpts - Optional Parameters:
	 * @param "UpdateConfigRequestData" (optional.Interface of UpdateConfigRequestData) -  The broker configuration parameter update request.
	 */
	ClustersClusterIdBrokersBrokerIdConfigsNamePut(ctx _context.Context, clusterId string, brokerId int32, name string, localVarOptionals *ClustersClusterIdBrokersBrokerIdConfigsNamePutOpts) (*_nethttp.Response, error)

	/*
	 * ClustersClusterIdBrokersBrokerIdConfigsalterPost Batch Alter Broker Configs
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Updates or deletes a set of broker configuration parameters.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param brokerId The Kafka broker ID.
	 * @param optional nil or *ClustersClusterIdBrokersBrokerIdConfigsalterPostOpts - Optional Parameters:
	 * @param "AlterConfigBatchRequestData" (optional.Interface of AlterConfigBatchRequestData) -  The alter broker configuration parameter batch request.
	 */
	ClustersClusterIdBrokersBrokerIdConfigsalterPost(ctx _context.Context, clusterId string, brokerId int32, localVarOptionals *ClustersClusterIdBrokersBrokerIdConfigsalterPostOpts) (*_nethttp.Response, error)

	/*
	 * ClustersClusterIdBrokersConfigsGet List All Broker Configs
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Return the list of configuration parameters for all the brokers in the given Kafka cluster.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @return BrokerConfigDataList
	 */
	ClustersClusterIdBrokersConfigsGet(ctx _context.Context, clusterId string) (BrokerConfigDataList, *_nethttp.Response, error)

	/*
	 * DeleteKafkaClusterConfig Reset Cluster Config
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Resets the configuration parameter specified by ``name`` to its default value.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param name The configuration parameter name.
	 */
	DeleteKafkaClusterConfig(ctx _context.Context, clusterId string, name string) (*_nethttp.Response, error)

	/*
	 * DeleteKafkaTopicConfig Reset Topic Config
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Resets the config with given `name` to its default value.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param topicName The topic name.
	 * @param name The configuration parameter name.
	 */
	DeleteKafkaTopicConfig(ctx _context.Context, clusterId string, topicName string, name string) (*_nethttp.Response, error)

	/*
	 * GetKafkaClusterConfig Get Cluster Config
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns the configuration parameter specified by ``name``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param name The configuration parameter name.
	 * @return ClusterConfigData
	 */
	GetKafkaClusterConfig(ctx _context.Context, clusterId string, name string) (ClusterConfigData, *_nethttp.Response, error)

	/*
	 * GetKafkaTopicConfig Get Topic Config
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Return the config with the given `name`.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param topicName The topic name.
	 * @param name The configuration parameter name.
	 * @return TopicConfigData
	 */
	GetKafkaTopicConfig(ctx _context.Context, clusterId string, topicName string, name string) (TopicConfigData, *_nethttp.Response, error)

	/*
	 * ListKafkaAllTopicConfigs Get All Topic Configs
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns all topic configurations for topics hosted by the specified cluster.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @return TopicConfigDataList
	 */
	ListKafkaAllTopicConfigs(ctx _context.Context, clusterId string) (TopicConfigDataList, *_nethttp.Response, error)

	/*
	 * ListKafkaClusterConfigs List Cluster Configs
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns a list of configuration parameters for the specified Kafka cluster.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @return ClusterConfigDataList
	 */
	ListKafkaClusterConfigs(ctx _context.Context, clusterId string) (ClusterConfigDataList, *_nethttp.Response, error)

	/*
	 * ListKafkaDefaultTopicConfigs List Default Topic Configs
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param topicName The topic name.
	 * @return TopicConfigDataList
	 */
	ListKafkaDefaultTopicConfigs(ctx _context.Context, clusterId string, topicName string) (TopicConfigDataList, *_nethttp.Response, error)

	/*
	 * ListKafkaTopicConfigs List Topic Configs
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Return the list of configs that belong to the specified topic.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param topicName The topic name.
	 * @return TopicConfigDataList
	 */
	ListKafkaTopicConfigs(ctx _context.Context, clusterId string, topicName string) (TopicConfigDataList, *_nethttp.Response, error)

	/*
	 * UpdateKafkaClusterConfig Update Cluster Config
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Updates the configuration parameter specified by ``name``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param name The configuration parameter name.
	 * @param optional nil or *UpdateKafkaClusterConfigOpts - Optional Parameters:
	 * @param "UpdateConfigRequestData" (optional.Interface of UpdateConfigRequestData) -  The cluster configuration parameter update request.
	 */
	UpdateKafkaClusterConfig(ctx _context.Context, clusterId string, name string, localVarOptionals *UpdateKafkaClusterConfigOpts) (*_nethttp.Response, error)

	/*
	 * UpdateKafkaClusterConfigs Batch Alter Cluster Configs
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Updates or deletes a set of Kafka cluster configuration parameters.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param optional nil or *UpdateKafkaClusterConfigsOpts - Optional Parameters:
	 * @param "AlterConfigBatchRequestData" (optional.Interface of AlterConfigBatchRequestData) -  The alter cluster configuration parameter batch request.
	 */
	UpdateKafkaClusterConfigs(ctx _context.Context, clusterId string, localVarOptionals *UpdateKafkaClusterConfigsOpts) (*_nethttp.Response, error)

	/*
	 * UpdateKafkaTopicConfig Update Topic Config
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Updates the config with given `name`.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param topicName The topic name.
	 * @param name The configuration parameter name.
	 * @param optional nil or *UpdateKafkaTopicConfigOpts - Optional Parameters:
	 * @param "UpdateConfigRequestData" (optional.Interface of UpdateConfigRequestData) -  The topic configuration parameter update request.
	 */
	UpdateKafkaTopicConfig(ctx _context.Context, clusterId string, topicName string, name string, localVarOptionals *UpdateKafkaTopicConfigOpts) (*_nethttp.Response, error)

	/*
	 * UpdateKafkaTopicConfigBatch Batch Alter Topic Configs
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Updates or deletes a set of topic configs.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param topicName The topic name.
	 * @param optional nil or *UpdateKafkaTopicConfigBatchOpts - Optional Parameters:
	 * @param "AlterConfigBatchRequestData" (optional.Interface of AlterConfigBatchRequestData) -  The alter topic configuration parameter batch request.
	 */
	UpdateKafkaTopicConfigBatch(ctx _context.Context, clusterId string, topicName string, localVarOptionals *UpdateKafkaTopicConfigBatchOpts) (*_nethttp.Response, error)
}

type ConfigsV3ApiService added in v0.3.8

type ConfigsV3ApiService service

ConfigsV3ApiService ConfigsV3Api service

func (*ConfigsV3ApiService) ClustersClusterIdBrokersBrokerIdConfigsGet added in v0.3.8

func (a *ConfigsV3ApiService) ClustersClusterIdBrokersBrokerIdConfigsGet(ctx _context.Context, clusterId string, brokerId int32) (BrokerConfigDataList, *_nethttp.Response, error)

* ClustersClusterIdBrokersBrokerIdConfigsGet List Broker Configs * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the list of configuration parameters that belong to the specified Kafka broker. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param brokerId The Kafka broker ID. * @return BrokerConfigDataList

func (*ConfigsV3ApiService) ClustersClusterIdBrokersBrokerIdConfigsNameDelete added in v0.3.8

func (a *ConfigsV3ApiService) ClustersClusterIdBrokersBrokerIdConfigsNameDelete(ctx _context.Context, clusterId string, brokerId int32, name string) (*_nethttp.Response, error)

* ClustersClusterIdBrokersBrokerIdConfigsNameDelete Reset Broker Config * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Resets the configuration parameter specified by ``name`` to its default value. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param brokerId The Kafka broker ID. * @param name The configuration parameter name.

func (*ConfigsV3ApiService) ClustersClusterIdBrokersBrokerIdConfigsNameGet added in v0.3.8

func (a *ConfigsV3ApiService) ClustersClusterIdBrokersBrokerIdConfigsNameGet(ctx _context.Context, clusterId string, brokerId int32, name string) (BrokerConfigData, *_nethttp.Response, error)

* ClustersClusterIdBrokersBrokerIdConfigsNameGet Get Broker Config * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the configuration parameter specified by ``name``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param brokerId The Kafka broker ID. * @param name The configuration parameter name. * @return BrokerConfigData

func (*ConfigsV3ApiService) ClustersClusterIdBrokersBrokerIdConfigsNamePut added in v0.3.8

func (a *ConfigsV3ApiService) ClustersClusterIdBrokersBrokerIdConfigsNamePut(ctx _context.Context, clusterId string, brokerId int32, name string, localVarOptionals *ClustersClusterIdBrokersBrokerIdConfigsNamePutOpts) (*_nethttp.Response, error)

* ClustersClusterIdBrokersBrokerIdConfigsNamePut Update Broker Config * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Updates the configuration parameter specified by ``name``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param brokerId The Kafka broker ID. * @param name The configuration parameter name. * @param optional nil or *ClustersClusterIdBrokersBrokerIdConfigsNamePutOpts - Optional Parameters: * @param "UpdateConfigRequestData" (optional.Interface of UpdateConfigRequestData) - The broker configuration parameter update request.

func (*ConfigsV3ApiService) ClustersClusterIdBrokersBrokerIdConfigsalterPost added in v0.3.8

func (a *ConfigsV3ApiService) ClustersClusterIdBrokersBrokerIdConfigsalterPost(ctx _context.Context, clusterId string, brokerId int32, localVarOptionals *ClustersClusterIdBrokersBrokerIdConfigsalterPostOpts) (*_nethttp.Response, error)

* ClustersClusterIdBrokersBrokerIdConfigsalterPost Batch Alter Broker Configs * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Updates or deletes a set of broker configuration parameters. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param brokerId The Kafka broker ID. * @param optional nil or *ClustersClusterIdBrokersBrokerIdConfigsalterPostOpts - Optional Parameters: * @param "AlterConfigBatchRequestData" (optional.Interface of AlterConfigBatchRequestData) - The alter broker configuration parameter batch request.

func (*ConfigsV3ApiService) ClustersClusterIdBrokersConfigsGet added in v0.3.8

func (a *ConfigsV3ApiService) ClustersClusterIdBrokersConfigsGet(ctx _context.Context, clusterId string) (BrokerConfigDataList, *_nethttp.Response, error)

* ClustersClusterIdBrokersConfigsGet List All Broker Configs * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the list of configuration parameters for all the brokers in the given Kafka cluster. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @return BrokerConfigDataList

func (*ConfigsV3ApiService) DeleteKafkaClusterConfig added in v0.3.8

func (a *ConfigsV3ApiService) DeleteKafkaClusterConfig(ctx _context.Context, clusterId string, name string) (*_nethttp.Response, error)

* DeleteKafkaClusterConfig Reset Cluster Config * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Resets the configuration parameter specified by ``name`` to its default value. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param name The configuration parameter name.

func (*ConfigsV3ApiService) DeleteKafkaTopicConfig added in v0.3.8

func (a *ConfigsV3ApiService) DeleteKafkaTopicConfig(ctx _context.Context, clusterId string, topicName string, name string) (*_nethttp.Response, error)

* DeleteKafkaTopicConfig Reset Topic Config * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Resets the config with given `name` to its default value. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param topicName The topic name. * @param name The configuration parameter name.

func (*ConfigsV3ApiService) GetKafkaClusterConfig added in v0.3.8

func (a *ConfigsV3ApiService) GetKafkaClusterConfig(ctx _context.Context, clusterId string, name string) (ClusterConfigData, *_nethttp.Response, error)

* GetKafkaClusterConfig Get Cluster Config * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the configuration parameter specified by ``name``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param name The configuration parameter name. * @return ClusterConfigData

func (*ConfigsV3ApiService) GetKafkaTopicConfig added in v0.3.8

func (a *ConfigsV3ApiService) GetKafkaTopicConfig(ctx _context.Context, clusterId string, topicName string, name string) (TopicConfigData, *_nethttp.Response, error)

* GetKafkaTopicConfig Get Topic Config * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the config with the given `name`. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param topicName The topic name. * @param name The configuration parameter name. * @return TopicConfigData

func (*ConfigsV3ApiService) ListKafkaAllTopicConfigs added in v0.3.8

func (a *ConfigsV3ApiService) ListKafkaAllTopicConfigs(ctx _context.Context, clusterId string) (TopicConfigDataList, *_nethttp.Response, error)

* ListKafkaAllTopicConfigs Get All Topic Configs * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns all topic configurations for topics hosted by the specified cluster. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @return TopicConfigDataList

func (*ConfigsV3ApiService) ListKafkaClusterConfigs added in v0.3.8

func (a *ConfigsV3ApiService) ListKafkaClusterConfigs(ctx _context.Context, clusterId string) (ClusterConfigDataList, *_nethttp.Response, error)

* ListKafkaClusterConfigs List Cluster Configs * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns a list of configuration parameters for the specified Kafka cluster. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @return ClusterConfigDataList

func (*ConfigsV3ApiService) ListKafkaDefaultTopicConfigs added in v0.3.8

func (a *ConfigsV3ApiService) ListKafkaDefaultTopicConfigs(ctx _context.Context, clusterId string, topicName string) (TopicConfigDataList, *_nethttp.Response, error)

* ListKafkaDefaultTopicConfigs List Default Topic Configs * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param topicName The topic name. * @return TopicConfigDataList

func (*ConfigsV3ApiService) ListKafkaTopicConfigs added in v0.3.8

func (a *ConfigsV3ApiService) ListKafkaTopicConfigs(ctx _context.Context, clusterId string, topicName string) (TopicConfigDataList, *_nethttp.Response, error)

* ListKafkaTopicConfigs List Topic Configs * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the list of configs that belong to the specified topic. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param topicName The topic name. * @return TopicConfigDataList

func (*ConfigsV3ApiService) UpdateKafkaClusterConfig added in v0.3.8

func (a *ConfigsV3ApiService) UpdateKafkaClusterConfig(ctx _context.Context, clusterId string, name string, localVarOptionals *UpdateKafkaClusterConfigOpts) (*_nethttp.Response, error)

* UpdateKafkaClusterConfig Update Cluster Config * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Updates the configuration parameter specified by ``name``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param name The configuration parameter name. * @param optional nil or *UpdateKafkaClusterConfigOpts - Optional Parameters: * @param "UpdateConfigRequestData" (optional.Interface of UpdateConfigRequestData) - The cluster configuration parameter update request.

func (*ConfigsV3ApiService) UpdateKafkaClusterConfigs added in v0.3.8

func (a *ConfigsV3ApiService) UpdateKafkaClusterConfigs(ctx _context.Context, clusterId string, localVarOptionals *UpdateKafkaClusterConfigsOpts) (*_nethttp.Response, error)

* UpdateKafkaClusterConfigs Batch Alter Cluster Configs * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Updates or deletes a set of Kafka cluster configuration parameters. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param optional nil or *UpdateKafkaClusterConfigsOpts - Optional Parameters: * @param "AlterConfigBatchRequestData" (optional.Interface of AlterConfigBatchRequestData) - The alter cluster configuration parameter batch request.

func (*ConfigsV3ApiService) UpdateKafkaTopicConfig added in v0.3.8

func (a *ConfigsV3ApiService) UpdateKafkaTopicConfig(ctx _context.Context, clusterId string, topicName string, name string, localVarOptionals *UpdateKafkaTopicConfigOpts) (*_nethttp.Response, error)

* UpdateKafkaTopicConfig Update Topic Config * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Updates the config with given `name`. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param topicName The topic name. * @param name The configuration parameter name. * @param optional nil or *UpdateKafkaTopicConfigOpts - Optional Parameters: * @param "UpdateConfigRequestData" (optional.Interface of UpdateConfigRequestData) - The topic configuration parameter update request.

func (*ConfigsV3ApiService) UpdateKafkaTopicConfigBatch added in v0.3.8

func (a *ConfigsV3ApiService) UpdateKafkaTopicConfigBatch(ctx _context.Context, clusterId string, topicName string, localVarOptionals *UpdateKafkaTopicConfigBatchOpts) (*_nethttp.Response, error)

* UpdateKafkaTopicConfigBatch Batch Alter Topic Configs * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Updates or deletes a set of topic configs. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param topicName The topic name. * @param optional nil or *UpdateKafkaTopicConfigBatchOpts - Optional Parameters: * @param "AlterConfigBatchRequestData" (optional.Interface of AlterConfigBatchRequestData) - The alter topic configuration parameter batch request.

type Configuration

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

type ConsumerAssignmentData

type ConsumerAssignmentData struct {
	Kind            string           `json:"kind"`
	Metadata        ResourceMetadata `json:"metadata"`
	ClusterId       string           `json:"cluster_id"`
	ConsumerGroupId string           `json:"consumer_group_id"`
	ConsumerId      string           `json:"consumer_id"`
	TopicName       string           `json:"topic_name"`
	PartitionId     int32            `json:"partition_id"`
	Partition       Relationship     `json:"partition"`
	Lag             Relationship     `json:"lag"`
}

ConsumerAssignmentData struct for ConsumerAssignmentData

type ConsumerAssignmentDataAllOf

type ConsumerAssignmentDataAllOf struct {
	ClusterId       string       `json:"cluster_id"`
	ConsumerGroupId string       `json:"consumer_group_id"`
	ConsumerId      string       `json:"consumer_id"`
	TopicName       string       `json:"topic_name"`
	PartitionId     int32        `json:"partition_id"`
	Partition       Relationship `json:"partition"`
	Lag             Relationship `json:"lag"`
}

ConsumerAssignmentDataAllOf struct for ConsumerAssignmentDataAllOf

type ConsumerAssignmentDataList

type ConsumerAssignmentDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []ConsumerAssignmentData   `json:"data"`
}

ConsumerAssignmentDataList struct for ConsumerAssignmentDataList

type ConsumerAssignmentDataListAllOf

type ConsumerAssignmentDataListAllOf struct {
	Data []ConsumerAssignmentData `json:"data"`
}

ConsumerAssignmentDataListAllOf struct for ConsumerAssignmentDataListAllOf

type ConsumerData

type ConsumerData struct {
	Kind            string           `json:"kind"`
	Metadata        ResourceMetadata `json:"metadata"`
	ClusterId       string           `json:"cluster_id"`
	ConsumerGroupId string           `json:"consumer_group_id"`
	ConsumerId      string           `json:"consumer_id"`
	InstanceId      *string          `json:"instance_id,omitempty"`
	ClientId        string           `json:"client_id"`
	Assignments     Relationship     `json:"assignments"`
}

ConsumerData struct for ConsumerData

type ConsumerDataAllOf

type ConsumerDataAllOf struct {
	ClusterId       string       `json:"cluster_id"`
	ConsumerGroupId string       `json:"consumer_group_id"`
	ConsumerId      string       `json:"consumer_id"`
	InstanceId      *string      `json:"instance_id,omitempty"`
	ClientId        string       `json:"client_id"`
	Assignments     Relationship `json:"assignments"`
}

ConsumerDataAllOf struct for ConsumerDataAllOf

type ConsumerDataList

type ConsumerDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []ConsumerData             `json:"data"`
}

ConsumerDataList struct for ConsumerDataList

type ConsumerDataListAllOf

type ConsumerDataListAllOf struct {
	Data []ConsumerData `json:"data"`
}

ConsumerDataListAllOf struct for ConsumerDataListAllOf

type ConsumerGroupData

type ConsumerGroupData struct {
	Kind              string           `json:"kind"`
	Metadata          ResourceMetadata `json:"metadata"`
	ClusterId         string           `json:"cluster_id"`
	ConsumerGroupId   string           `json:"consumer_group_id"`
	IsSimple          bool             `json:"is_simple"`
	PartitionAssignor string           `json:"partition_assignor"`
	State             string           `json:"state"`
	Coordinator       Relationship     `json:"coordinator"`
	Consumer          Relationship     `json:"consumer,omitempty"`
	LagSummary        Relationship     `json:"lag_summary"`
}

ConsumerGroupData struct for ConsumerGroupData

type ConsumerGroupDataAllOf

type ConsumerGroupDataAllOf struct {
	ClusterId         string       `json:"cluster_id"`
	ConsumerGroupId   string       `json:"consumer_group_id"`
	IsSimple          bool         `json:"is_simple"`
	PartitionAssignor string       `json:"partition_assignor"`
	State             string       `json:"state"`
	Coordinator       Relationship `json:"coordinator"`
	Consumer          Relationship `json:"consumer,omitempty"`
	LagSummary        Relationship `json:"lag_summary"`
}

ConsumerGroupDataAllOf struct for ConsumerGroupDataAllOf

type ConsumerGroupDataList

type ConsumerGroupDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []ConsumerGroupData        `json:"data"`
}

ConsumerGroupDataList struct for ConsumerGroupDataList

type ConsumerGroupDataListAllOf

type ConsumerGroupDataListAllOf struct {
	Data []ConsumerGroupData `json:"data"`
}

ConsumerGroupDataListAllOf struct for ConsumerGroupDataListAllOf

type ConsumerGroupLagSummaryData

type ConsumerGroupLagSummaryData struct {
	Kind              string           `json:"kind"`
	Metadata          ResourceMetadata `json:"metadata"`
	ClusterId         string           `json:"cluster_id"`
	ConsumerGroupId   string           `json:"consumer_group_id"`
	MaxLagConsumerId  string           `json:"max_lag_consumer_id"`
	MaxLagInstanceId  *string          `json:"max_lag_instance_id,omitempty"`
	MaxLagClientId    string           `json:"max_lag_client_id"`
	MaxLagTopicName   string           `json:"max_lag_topic_name"`
	MaxLagPartitionId int32            `json:"max_lag_partition_id"`
	MaxLag            int64            `json:"max_lag"`
	TotalLag          int64            `json:"total_lag"`
	MaxLagConsumer    Relationship     `json:"max_lag_consumer"`
	MaxLagPartition   Relationship     `json:"max_lag_partition"`
}

ConsumerGroupLagSummaryData struct for ConsumerGroupLagSummaryData

type ConsumerGroupLagSummaryDataAllOf

type ConsumerGroupLagSummaryDataAllOf struct {
	ClusterId         string       `json:"cluster_id"`
	ConsumerGroupId   string       `json:"consumer_group_id"`
	MaxLagConsumerId  string       `json:"max_lag_consumer_id"`
	MaxLagInstanceId  *string      `json:"max_lag_instance_id,omitempty"`
	MaxLagClientId    string       `json:"max_lag_client_id"`
	MaxLagTopicName   string       `json:"max_lag_topic_name"`
	MaxLagPartitionId int32        `json:"max_lag_partition_id"`
	MaxLag            int64        `json:"max_lag"`
	TotalLag          int64        `json:"total_lag"`
	MaxLagConsumer    Relationship `json:"max_lag_consumer"`
	MaxLagPartition   Relationship `json:"max_lag_partition"`
}

ConsumerGroupLagSummaryDataAllOf struct for ConsumerGroupLagSummaryDataAllOf

type ConsumerGroupV3Api added in v0.3.8

type ConsumerGroupV3Api interface {

	/*
	 * GetKafkaConsumer Get Consumer
	 *
	 * [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Cluster Admin for Kafka (v3)](https://img.shields.io/badge/-Request%20Access%20To%20Cluster%20Admin%20For%20Kafka%20v3-%23bc8540)](mailto:ccloud-rest-api+consumer-lag-earlyaccess@confluent.io?subject=Request%20to%20join%20v3%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cluster%20Admin%20For%20Kafka%20v3%20Early%20Access%20to%20provide%20early%20feedback%20on%20consumer%20lag%20apis%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)  Returns the consumer specified by the ``consumer_id``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param consumerGroupId The consumer group ID.
	 * @param consumerId The consumer ID.
	 * @return ConsumerData
	 */
	GetKafkaConsumer(ctx _context.Context, clusterId string, consumerGroupId string, consumerId string) (ConsumerData, *_nethttp.Response, error)

	/*
	 * GetKafkaConsumerAssignment Get Consumer Assignment
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns information about the assignment for the specified consumer to the specified partition.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param consumerGroupId The consumer group ID.
	 * @param consumerId The consumer ID.
	 * @param topicName The topic name.
	 * @param partitionId The partition ID.
	 * @return ConsumerAssignmentData
	 */
	GetKafkaConsumerAssignment(ctx _context.Context, clusterId string, consumerGroupId string, consumerId string, topicName string, partitionId int32) (ConsumerAssignmentData, *_nethttp.Response, error)

	/*
	 * GetKafkaConsumerGroup Get Consumer Group
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns the consumer group specified by the ``consumer_group_id``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param consumerGroupId The consumer group ID.
	 * @return ConsumerGroupData
	 */
	GetKafkaConsumerGroup(ctx _context.Context, clusterId string, consumerGroupId string) (ConsumerGroupData, *_nethttp.Response, error)

	/*
	 * GetKafkaConsumerGroupLagSummary Get Consumer Group Lag Summary.
	 *
	 * [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Cluster Admin for Kafka (v3)](https://img.shields.io/badge/-Request%20Access%20To%20Cluster%20Admin%20For%20Kafka%20v3-%23bc8540)](mailto:ccloud-rest-api+consumer-lag-earlyaccess@confluent.io?subject=Request%20to%20join%20v3%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cluster%20Admin%20For%20Kafka%20v3%20Early%20Access%20to%20provide%20early%20feedback%20on%20consumer%20lag%20apis%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)  Returns the max and total lag of the consumers belonging to the specified consumer group.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param consumerGroupId The consumer group ID.
	 * @return ConsumerGroupLagSummaryData
	 */
	GetKafkaConsumerGroupLagSummary(ctx _context.Context, clusterId string, consumerGroupId string) (ConsumerGroupLagSummaryData, *_nethttp.Response, error)

	/*
	 * ListKafkaConsumerAssignment List Consumer Assignments
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns a list of partition assignments for the specified consumer.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param consumerGroupId The consumer group ID.
	 * @param consumerId The consumer ID.
	 * @return ConsumerAssignmentDataList
	 */
	ListKafkaConsumerAssignment(ctx _context.Context, clusterId string, consumerGroupId string, consumerId string) (ConsumerAssignmentDataList, *_nethttp.Response, error)

	/*
	 * ListKafkaConsumerGroups List Consumer Groups
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns the list of consumer groups that belong to the specified Kafka cluster.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @return ConsumerGroupDataList
	 */
	ListKafkaConsumerGroups(ctx _context.Context, clusterId string) (ConsumerGroupDataList, *_nethttp.Response, error)

	/*
	 * ListKafkaConsumerLags List Consumer Lags
	 *
	 * [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Cluster Admin for Kafka (v3)](https://img.shields.io/badge/-Request%20Access%20To%20Cluster%20Admin%20For%20Kafka%20v3-%23bc8540)](mailto:ccloud-rest-api+consumer-lag-earlyaccess@confluent.io?subject=Request%20to%20join%20v3%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cluster%20Admin%20For%20Kafka%20v3%20Early%20Access%20to%20provide%20early%20feedback%20on%20consumer%20lag%20apis%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)  Returns a list of consumer lags of the consumers belonging to the specified consumer group.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param consumerGroupId The consumer group ID.
	 * @return ConsumerLagDataList
	 */
	ListKafkaConsumerLags(ctx _context.Context, clusterId string, consumerGroupId string) (ConsumerLagDataList, *_nethttp.Response, error)

	/*
	 * ListKafkaConsumers List Consumers
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns a list of consumers that belong to the specified consumer group.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param consumerGroupId The consumer group ID.
	 * @return ConsumerDataList
	 */
	ListKafkaConsumers(ctx _context.Context, clusterId string, consumerGroupId string) (ConsumerDataList, *_nethttp.Response, error)
}

type ConsumerGroupV3ApiService added in v0.3.8

type ConsumerGroupV3ApiService service

ConsumerGroupV3ApiService ConsumerGroupV3Api service

func (*ConsumerGroupV3ApiService) GetKafkaConsumer added in v0.3.8

func (a *ConsumerGroupV3ApiService) GetKafkaConsumer(ctx _context.Context, clusterId string, consumerGroupId string, consumerId string) (ConsumerData, *_nethttp.Response, error)

* GetKafkaConsumer Get Consumer * * [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Cluster Admin for Kafka (v3)](https://img.shields.io/badge/-Request%20Access%20To%20Cluster%20Admin%20For%20Kafka%20v3-%23bc8540)](mailto:ccloud-rest-api+consumer-lag-earlyaccess@confluent.io?subject=Request%20to%20join%20v3%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cluster%20Admin%20For%20Kafka%20v3%20Early%20Access%20to%20provide%20early%20feedback%20on%20consumer%20lag%20apis%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Returns the consumer specified by the ``consumer_id``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param consumerGroupId The consumer group ID. * @param consumerId The consumer ID. * @return ConsumerData

func (*ConsumerGroupV3ApiService) GetKafkaConsumerAssignment added in v0.3.8

func (a *ConsumerGroupV3ApiService) GetKafkaConsumerAssignment(ctx _context.Context, clusterId string, consumerGroupId string, consumerId string, topicName string, partitionId int32) (ConsumerAssignmentData, *_nethttp.Response, error)

* GetKafkaConsumerAssignment Get Consumer Assignment * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns information about the assignment for the specified consumer to the specified partition. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param consumerGroupId The consumer group ID. * @param consumerId The consumer ID. * @param topicName The topic name. * @param partitionId The partition ID. * @return ConsumerAssignmentData

func (*ConsumerGroupV3ApiService) GetKafkaConsumerGroup added in v0.3.8

func (a *ConsumerGroupV3ApiService) GetKafkaConsumerGroup(ctx _context.Context, clusterId string, consumerGroupId string) (ConsumerGroupData, *_nethttp.Response, error)

* GetKafkaConsumerGroup Get Consumer Group * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the consumer group specified by the ``consumer_group_id``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param consumerGroupId The consumer group ID. * @return ConsumerGroupData

func (*ConsumerGroupV3ApiService) GetKafkaConsumerGroupLagSummary added in v0.3.8

func (a *ConsumerGroupV3ApiService) GetKafkaConsumerGroupLagSummary(ctx _context.Context, clusterId string, consumerGroupId string) (ConsumerGroupLagSummaryData, *_nethttp.Response, error)

* GetKafkaConsumerGroupLagSummary Get Consumer Group Lag Summary. * * [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Cluster Admin for Kafka (v3)](https://img.shields.io/badge/-Request%20Access%20To%20Cluster%20Admin%20For%20Kafka%20v3-%23bc8540)](mailto:ccloud-rest-api+consumer-lag-earlyaccess@confluent.io?subject=Request%20to%20join%20v3%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cluster%20Admin%20For%20Kafka%20v3%20Early%20Access%20to%20provide%20early%20feedback%20on%20consumer%20lag%20apis%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Returns the max and total lag of the consumers belonging to the specified consumer group. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param consumerGroupId The consumer group ID. * @return ConsumerGroupLagSummaryData

func (*ConsumerGroupV3ApiService) ListKafkaConsumerAssignment added in v0.3.8

func (a *ConsumerGroupV3ApiService) ListKafkaConsumerAssignment(ctx _context.Context, clusterId string, consumerGroupId string, consumerId string) (ConsumerAssignmentDataList, *_nethttp.Response, error)

* ListKafkaConsumerAssignment List Consumer Assignments * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns a list of partition assignments for the specified consumer. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param consumerGroupId The consumer group ID. * @param consumerId The consumer ID. * @return ConsumerAssignmentDataList

func (*ConsumerGroupV3ApiService) ListKafkaConsumerGroups added in v0.3.8

func (a *ConsumerGroupV3ApiService) ListKafkaConsumerGroups(ctx _context.Context, clusterId string) (ConsumerGroupDataList, *_nethttp.Response, error)

* ListKafkaConsumerGroups List Consumer Groups * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the list of consumer groups that belong to the specified Kafka cluster. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @return ConsumerGroupDataList

func (*ConsumerGroupV3ApiService) ListKafkaConsumerLags added in v0.3.8

func (a *ConsumerGroupV3ApiService) ListKafkaConsumerLags(ctx _context.Context, clusterId string, consumerGroupId string) (ConsumerLagDataList, *_nethttp.Response, error)

* ListKafkaConsumerLags List Consumer Lags * * [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Cluster Admin for Kafka (v3)](https://img.shields.io/badge/-Request%20Access%20To%20Cluster%20Admin%20For%20Kafka%20v3-%23bc8540)](mailto:ccloud-rest-api+consumer-lag-earlyaccess@confluent.io?subject=Request%20to%20join%20v3%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cluster%20Admin%20For%20Kafka%20v3%20Early%20Access%20to%20provide%20early%20feedback%20on%20consumer%20lag%20apis%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Returns a list of consumer lags of the consumers belonging to the specified consumer group. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param consumerGroupId The consumer group ID. * @return ConsumerLagDataList

func (*ConsumerGroupV3ApiService) ListKafkaConsumers added in v0.3.8

func (a *ConsumerGroupV3ApiService) ListKafkaConsumers(ctx _context.Context, clusterId string, consumerGroupId string) (ConsumerDataList, *_nethttp.Response, error)

* ListKafkaConsumers List Consumers * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns a list of consumers that belong to the specified consumer group. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param consumerGroupId The consumer group ID. * @return ConsumerDataList

type ConsumerLagData

type ConsumerLagData struct {
	Kind            string           `json:"kind"`
	Metadata        ResourceMetadata `json:"metadata"`
	ClusterId       string           `json:"cluster_id"`
	ConsumerGroupId string           `json:"consumer_group_id"`
	TopicName       string           `json:"topic_name"`
	PartitionId     int32            `json:"partition_id"`
	CurrentOffset   int64            `json:"current_offset"`
	LogEndOffset    int64            `json:"log_end_offset"`
	Lag             int64            `json:"lag"`
	ConsumerId      string           `json:"consumer_id"`
	InstanceId      *string          `json:"instance_id,omitempty"`
	ClientId        string           `json:"client_id"`
}

ConsumerLagData struct for ConsumerLagData

type ConsumerLagDataAllOf

type ConsumerLagDataAllOf struct {
	ClusterId       string  `json:"cluster_id"`
	ConsumerGroupId string  `json:"consumer_group_id"`
	TopicName       string  `json:"topic_name"`
	PartitionId     int32   `json:"partition_id"`
	CurrentOffset   int64   `json:"current_offset"`
	LogEndOffset    int64   `json:"log_end_offset"`
	Lag             int64   `json:"lag"`
	ConsumerId      string  `json:"consumer_id"`
	InstanceId      *string `json:"instance_id,omitempty"`
	ClientId        string  `json:"client_id"`
}

ConsumerLagDataAllOf struct for ConsumerLagDataAllOf

type ConsumerLagDataList

type ConsumerLagDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []ConsumerLagData          `json:"data"`
}

ConsumerLagDataList struct for ConsumerLagDataList

type ConsumerLagDataListAllOf

type ConsumerLagDataListAllOf struct {
	Data []ConsumerLagData `json:"data"`
}

ConsumerLagDataListAllOf struct for ConsumerLagDataListAllOf

type CreateAclRequestData

type CreateAclRequestData struct {
	ResourceType AclResourceType `json:"resource_type"`
	ResourceName string          `json:"resource_name"`
	PatternType  string          `json:"pattern_type"`
	Principal    string          `json:"principal"`
	Host         string          `json:"host"`
	Operation    string          `json:"operation"`
	Permission   string          `json:"permission"`
}

CreateAclRequestData struct for CreateAclRequestData

type CreateKafkaAclsOpts added in v0.3.8

type CreateKafkaAclsOpts struct {
	CreateAclRequestData optional.Interface
}

CreateKafkaAclsOpts Optional parameters for the method 'CreateKafkaAcls'

type CreateKafkaLinkOpts added in v0.3.8

type CreateKafkaLinkOpts struct {
	ValidateOnly          optional.Bool
	ValidateLink          optional.Bool
	CreateLinkRequestData optional.Interface
}

CreateKafkaLinkOpts Optional parameters for the method 'CreateKafkaLink'

type CreateKafkaMirrorTopicOpts added in v0.3.8

type CreateKafkaMirrorTopicOpts struct {
	CreateMirrorTopicRequestData optional.Interface
}

CreateKafkaMirrorTopicOpts Optional parameters for the method 'CreateKafkaMirrorTopic'

type CreateKafkaTopicOpts added in v0.3.8

type CreateKafkaTopicOpts struct {
	CreateTopicRequestData optional.Interface
}

CreateKafkaTopicOpts Optional parameters for the method 'CreateKafkaTopic'

type CreateLinkRequestData

type CreateLinkRequestData struct {
	SourceClusterId      string       `json:"source_cluster_id,omitempty"`
	DestinationClusterId string       `json:"destination_cluster_id,omitempty"`
	RemoteClusterId      string       `json:"remote_cluster_id,omitempty"`
	ClusterLinkId        string       `json:"cluster_link_id,omitempty"`
	Configs              []ConfigData `json:"configs,omitempty"`
}

CreateLinkRequestData struct for CreateLinkRequestData

type CreateMirrorTopicRequestData

type CreateMirrorTopicRequestData struct {
	SourceTopicName   string       `json:"source_topic_name"`
	MirrorTopicName   string       `json:"mirror_topic_name,omitempty"`
	ReplicationFactor int32        `json:"replication_factor,omitempty"`
	Configs           []ConfigData `json:"configs,omitempty"`
}

CreateMirrorTopicRequestData struct for CreateMirrorTopicRequestData

type CreateTopicRequestData

type CreateTopicRequestData struct {
	TopicName           string                                      `json:"topic_name"`
	PartitionsCount     int32                                       `json:"partitions_count,omitempty"`
	ReplicationFactor   int32                                       `json:"replication_factor,omitempty"`
	ReplicasAssignments []CreateTopicRequestDataReplicasAssignments `json:"replicas_assignments,omitempty"`
	Configs             []CreateTopicRequestDataConfigs             `json:"configs,omitempty"`
}

CreateTopicRequestData struct for CreateTopicRequestData

type CreateTopicRequestDataConfigs

type CreateTopicRequestDataConfigs struct {
	Name  string  `json:"name"`
	Value *string `json:"value,omitempty"`
}

CreateTopicRequestDataConfigs struct for CreateTopicRequestDataConfigs

type CreateTopicRequestDataReplicasAssignments

type CreateTopicRequestDataReplicasAssignments struct {
	PartitionId int32   `json:"partition_id"`
	BrokerIds   []int32 `json:"broker_ids"`
}

CreateTopicRequestDataReplicasAssignments struct for CreateTopicRequestDataReplicasAssignments

type DeleteKafkaAclsOpts added in v0.3.8

type DeleteKafkaAclsOpts struct {
	ResourceType optional.Interface
	ResourceName optional.String
	PatternType  optional.String
	Principal    optional.String
	Host         optional.String
	Operation    optional.String
	Permission   optional.String
}

DeleteKafkaAclsOpts Optional parameters for the method 'DeleteKafkaAcls'

type DeleteKafkaLinkOpts added in v0.3.14

type DeleteKafkaLinkOpts struct {
	Force        optional.Bool
	ValidateOnly optional.Bool
}

DeleteKafkaLinkOpts Optional parameters for the method 'DeleteKafkaLink'

type Error

type Error struct {
	ErrorCode int32   `json:"error_code"`
	Message   *string `json:"message"`
}

Error struct for Error

type GenericOpenAPIError

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

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GetKafkaAclsOpts added in v0.3.8

type GetKafkaAclsOpts struct {
	ResourceType optional.Interface
	ResourceName optional.String
	PatternType  optional.String
	Principal    optional.String
	Host         optional.String
	Operation    optional.String
	Permission   optional.String
}

GetKafkaAclsOpts Optional parameters for the method 'GetKafkaAcls'

type GetKafkaLinkOpts added in v0.3.18

type GetKafkaLinkOpts struct {
	IncludeTasks optional.Bool
}

GetKafkaLinkOpts Optional parameters for the method 'GetKafkaLink'

type InlineResponse200

type InlineResponse200 struct {
	Data []AclData `json:"data"`
}

InlineResponse200 struct for InlineResponse200

type LinkTask added in v0.3.18

type LinkTask struct {
	TaskName string          `json:"task_name"`
	State    string          `json:"state"`
	Errors   []LinkTaskError `json:"errors"`
}

LinkTask struct for LinkTask

type LinkTaskError added in v0.3.18

type LinkTaskError struct {
	ErrorCode    string `json:"error_code"`
	ErrorMessage string `json:"error_message"`
}

LinkTaskError struct for LinkTaskError

type ListKafkaMirrorTopicsOpts added in v0.3.8

type ListKafkaMirrorTopicsOpts struct {
	MirrorStatus optional.Interface
}

ListKafkaMirrorTopicsOpts Optional parameters for the method 'ListKafkaMirrorTopics'

type ListKafkaMirrorTopicsUnderLinkOpts added in v0.3.8

type ListKafkaMirrorTopicsUnderLinkOpts struct {
	MirrorStatus optional.Interface
}

ListKafkaMirrorTopicsUnderLinkOpts Optional parameters for the method 'ListKafkaMirrorTopicsUnderLink'

type ListLinkConfigsResponseData

type ListLinkConfigsResponseData struct {
	Kind      string           `json:"kind"`
	Metadata  ResourceMetadata `json:"metadata"`
	ClusterId string           `json:"cluster_id"`
	Name      string           `json:"name"`
	Value     string           `json:"value"`
	ReadOnly  bool             `json:"read_only"`
	Sensitive bool             `json:"sensitive"`
	Source    string           `json:"source"`
	Synonyms  []string         `json:"synonyms"`
	LinkName  string           `json:"link_name"`
}

ListLinkConfigsResponseData struct for ListLinkConfigsResponseData

type ListLinkConfigsResponseDataAllOf

type ListLinkConfigsResponseDataAllOf struct {
	ClusterId string   `json:"cluster_id"`
	Name      string   `json:"name"`
	Value     string   `json:"value"`
	ReadOnly  bool     `json:"read_only"`
	Sensitive bool     `json:"sensitive"`
	Source    string   `json:"source"`
	Synonyms  []string `json:"synonyms"`
	LinkName  string   `json:"link_name"`
}

ListLinkConfigsResponseDataAllOf struct for ListLinkConfigsResponseDataAllOf

type ListLinkConfigsResponseDataList

type ListLinkConfigsResponseDataList struct {
	Kind     string                        `json:"kind"`
	Metadata ResourceCollectionMetadata    `json:"metadata"`
	Data     []ListLinkConfigsResponseData `json:"data"`
}

ListLinkConfigsResponseDataList struct for ListLinkConfigsResponseDataList

type ListLinkConfigsResponseDataListAllOf

type ListLinkConfigsResponseDataListAllOf struct {
	Data []ListLinkConfigsResponseData `json:"data"`
}

ListLinkConfigsResponseDataListAllOf struct for ListLinkConfigsResponseDataListAllOf

type ListLinksResponseData

type ListLinksResponseData struct {
	Kind                 string           `json:"kind"`
	Metadata             ResourceMetadata `json:"metadata"`
	SourceClusterId      *string          `json:"source_cluster_id,omitempty"`
	DestinationClusterId *string          `json:"destination_cluster_id,omitempty"`
	RemoteClusterId      *string          `json:"remote_cluster_id,omitempty"`
	LinkName             string           `json:"link_name"`
	LinkId               string           `json:"link_id,omitempty"`
	ClusterLinkId        string           `json:"cluster_link_id"`
	TopicNames           []string         `json:"topic_names"`
	LinkError            string           `json:"link_error,omitempty"`
	LinkErrorMessage     *string          `json:"link_error_message,omitempty"`
	LinkState            string           `json:"link_state,omitempty"`
	Tasks                *[]LinkTask      `json:"tasks,omitempty"`
}

ListLinksResponseData struct for ListLinksResponseData

type ListLinksResponseDataAllOf

type ListLinksResponseDataAllOf struct {
	SourceClusterId      *string     `json:"source_cluster_id,omitempty"`
	DestinationClusterId *string     `json:"destination_cluster_id,omitempty"`
	RemoteClusterId      *string     `json:"remote_cluster_id,omitempty"`
	LinkName             string      `json:"link_name"`
	LinkId               string      `json:"link_id,omitempty"`
	ClusterLinkId        string      `json:"cluster_link_id"`
	TopicNames           []string    `json:"topic_names"`
	LinkError            string      `json:"link_error,omitempty"`
	LinkErrorMessage     *string     `json:"link_error_message,omitempty"`
	LinkState            string      `json:"link_state,omitempty"`
	Tasks                *[]LinkTask `json:"tasks,omitempty"`
}

ListLinksResponseDataAllOf struct for ListLinksResponseDataAllOf

type ListLinksResponseDataList

type ListLinksResponseDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []ListLinksResponseData    `json:"data"`
}

ListLinksResponseDataList struct for ListLinksResponseDataList

type ListLinksResponseDataListAllOf

type ListLinksResponseDataListAllOf struct {
	Data []ListLinksResponseData `json:"data"`
}

ListLinksResponseDataListAllOf struct for ListLinksResponseDataListAllOf

type ListMirrorTopicsResponseData

type ListMirrorTopicsResponseData struct {
	Kind                        string            `json:"kind"`
	Metadata                    ResourceMetadata  `json:"metadata"`
	LinkName                    string            `json:"link_name"`
	MirrorTopicName             string            `json:"mirror_topic_name"`
	SourceTopicName             string            `json:"source_topic_name"`
	NumPartitions               int32             `json:"num_partitions"`
	MirrorLags                  []MirrorLag       `json:"mirror_lags"`
	MirrorStatus                MirrorTopicStatus `json:"mirror_status"`
	MirrorTopicError            string            `json:"mirror_topic_error"`
	StateTimeMs                 int64             `json:"state_time_ms"`
	MirrorStateTransitionErrors []LinkTaskError   `json:"mirror_state_transition_errors,omitempty"`
}

ListMirrorTopicsResponseData struct for ListMirrorTopicsResponseData

type ListMirrorTopicsResponseDataAllOf

type ListMirrorTopicsResponseDataAllOf struct {
	LinkName                    string            `json:"link_name"`
	MirrorTopicName             string            `json:"mirror_topic_name"`
	SourceTopicName             string            `json:"source_topic_name"`
	NumPartitions               int32             `json:"num_partitions"`
	MirrorLags                  []MirrorLag       `json:"mirror_lags"`
	MirrorStatus                MirrorTopicStatus `json:"mirror_status"`
	MirrorTopicError            string            `json:"mirror_topic_error"`
	StateTimeMs                 int64             `json:"state_time_ms"`
	MirrorStateTransitionErrors []LinkTaskError   `json:"mirror_state_transition_errors,omitempty"`
}

ListMirrorTopicsResponseDataAllOf struct for ListMirrorTopicsResponseDataAllOf

type ListMirrorTopicsResponseDataList

type ListMirrorTopicsResponseDataList struct {
	Kind     string                         `json:"kind"`
	Metadata ResourceCollectionMetadata     `json:"metadata"`
	Data     []ListMirrorTopicsResponseData `json:"data"`
}

ListMirrorTopicsResponseDataList struct for ListMirrorTopicsResponseDataList

type ListMirrorTopicsResponseDataListAllOf

type ListMirrorTopicsResponseDataListAllOf struct {
	Data []ListMirrorTopicsResponseData `json:"data"`
}

ListMirrorTopicsResponseDataListAllOf struct for ListMirrorTopicsResponseDataListAllOf

type MirrorLag

type MirrorLag struct {
	Partition             int32 `json:"partition"`
	Lag                   int64 `json:"lag"`
	LastSourceFetchOffset int64 `json:"last_source_fetch_offset"`
}

MirrorLag struct for MirrorLag

type MirrorTopicStatus

type MirrorTopicStatus string

MirrorTopicStatus the model 'MirrorTopicStatus'

const (
	MIRRORTOPICSTATUS_ACTIVE              MirrorTopicStatus = "ACTIVE"
	MIRRORTOPICSTATUS_FAILED              MirrorTopicStatus = "FAILED"
	MIRRORTOPICSTATUS_LINK_FAILED         MirrorTopicStatus = "LINK_FAILED"
	MIRRORTOPICSTATUS_LINK_PAUSED         MirrorTopicStatus = "LINK_PAUSED"
	MIRRORTOPICSTATUS_PAUSED              MirrorTopicStatus = "PAUSED"
	MIRRORTOPICSTATUS_PENDING_STOPPED     MirrorTopicStatus = "PENDING_STOPPED"
	MIRRORTOPICSTATUS_SOURCE_UNAVAILABLE  MirrorTopicStatus = "SOURCE_UNAVAILABLE"
	MIRRORTOPICSTATUS_STOPPED             MirrorTopicStatus = "STOPPED"
	MIRRORTOPICSTATUS_UNKNOWN             MirrorTopicStatus = "UNKNOWN"
	MIRRORTOPICSTATUS_PENDING_SYNCHRONIZE MirrorTopicStatus = "PENDING_SYNCHRONIZE"
	MIRRORTOPICSTATUS_PENDING_MIRROR      MirrorTopicStatus = "PENDING_MIRROR"
)

List of MirrorTopicStatus

type PartitionApi

type PartitionApi interface {

	/*
	 * ClustersClusterIdTopicsPartitionsReassignmentGet List All Replica Reassignments
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns the list of all ongoing replica reassignments in the given Kafka cluster.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @return ReassignmentDataList
	 */
	ClustersClusterIdTopicsPartitionsReassignmentGet(ctx _context.Context, clusterId string) (ReassignmentDataList, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReassignmentGet Get Replica Reassignments
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns the list of ongoing replica reassignments for the given partition.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param topicName The topic name.
	 * @param partitionId The partition ID.
	 * @return ReassignmentData
	 */
	ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReassignmentGet(ctx _context.Context, clusterId string, topicName string, partitionId int32) (ReassignmentData, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdTopicsTopicNamePartitionsReassignmentGet Search Replica Reassignments By Topic
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns the list of ongoing replica reassignments for the given topic.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param topicName The topic name.
	 * @return ReassignmentDataList
	 */
	ClustersClusterIdTopicsTopicNamePartitionsReassignmentGet(ctx _context.Context, clusterId string, topicName string) (ReassignmentDataList, *_nethttp.Response, error)
}

type PartitionApiService

type PartitionApiService service

PartitionApiService PartitionApi service

func (*PartitionApiService) ClustersClusterIdTopicsPartitionsReassignmentGet

func (a *PartitionApiService) ClustersClusterIdTopicsPartitionsReassignmentGet(ctx _context.Context, clusterId string) (ReassignmentDataList, *_nethttp.Response, error)

* ClustersClusterIdTopicsPartitionsReassignmentGet List All Replica Reassignments * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the list of all ongoing replica reassignments in the given Kafka cluster. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @return ReassignmentDataList

func (*PartitionApiService) ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReassignmentGet

func (a *PartitionApiService) ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReassignmentGet(ctx _context.Context, clusterId string, topicName string, partitionId int32) (ReassignmentData, *_nethttp.Response, error)

* ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReassignmentGet Get Replica Reassignments * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the list of ongoing replica reassignments for the given partition. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param topicName The topic name. * @param partitionId The partition ID. * @return ReassignmentData

func (*PartitionApiService) ClustersClusterIdTopicsTopicNamePartitionsReassignmentGet

func (a *PartitionApiService) ClustersClusterIdTopicsTopicNamePartitionsReassignmentGet(ctx _context.Context, clusterId string, topicName string) (ReassignmentDataList, *_nethttp.Response, error)

* ClustersClusterIdTopicsTopicNamePartitionsReassignmentGet Search Replica Reassignments By Topic * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the list of ongoing replica reassignments for the given topic. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param topicName The topic name. * @return ReassignmentDataList

type PartitionData

type PartitionData struct {
	Kind         string           `json:"kind"`
	Metadata     ResourceMetadata `json:"metadata"`
	ClusterId    string           `json:"cluster_id"`
	TopicName    string           `json:"topic_name"`
	PartitionId  int32            `json:"partition_id"`
	Leader       Relationship     `json:"leader,omitempty"`
	Replicas     Relationship     `json:"replicas"`
	Reassignment Relationship     `json:"reassignment"`
}

PartitionData struct for PartitionData

type PartitionDataAllOf

type PartitionDataAllOf struct {
	ClusterId    string       `json:"cluster_id"`
	TopicName    string       `json:"topic_name"`
	PartitionId  int32        `json:"partition_id"`
	Leader       Relationship `json:"leader,omitempty"`
	Replicas     Relationship `json:"replicas"`
	Reassignment Relationship `json:"reassignment"`
}

PartitionDataAllOf struct for PartitionDataAllOf

type PartitionDataList

type PartitionDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []PartitionData            `json:"data"`
}

PartitionDataList struct for PartitionDataList

type PartitionDataListAllOf

type PartitionDataListAllOf struct {
	Data []PartitionData `json:"data"`
}

PartitionDataListAllOf struct for PartitionDataListAllOf

type PartitionV3Api added in v0.3.8

type PartitionV3Api interface {

	/*
	 * GetKafkaConsumerLag Get Consumer Lag
	 *
	 * [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Cluster Admin for Kafka (v3)](https://img.shields.io/badge/-Request%20Access%20To%20Cluster%20Admin%20For%20Kafka%20v3-%23bc8540)](mailto:ccloud-rest-api+consumer-lag-earlyaccess@confluent.io?subject=Request%20to%20join%20v3%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cluster%20Admin%20For%20Kafka%20v3%20Early%20Access%20to%20provide%20early%20feedback%20on%20consumer%20lag%20apis%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)  Returns the consumer lag on a partition with the given `partition_id`.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param consumerGroupId The consumer group ID.
	 * @param topicName The topic name.
	 * @param partitionId The partition ID.
	 * @return ConsumerLagData
	 */
	GetKafkaConsumerLag(ctx _context.Context, clusterId string, consumerGroupId string, topicName string, partitionId int32) (ConsumerLagData, *_nethttp.Response, error)

	/*
	 * GetKafkaPartition Get Partition
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns the partition with the given `partition_id`.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param topicName The topic name.
	 * @param partitionId The partition ID.
	 * @return PartitionData
	 */
	GetKafkaPartition(ctx _context.Context, clusterId string, topicName string, partitionId int32) (PartitionData, *_nethttp.Response, error)

	/*
	 * ListKafkaPartitions List Partitions
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns the list of partitions that belong to the specified topic.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param topicName The topic name.
	 * @return PartitionDataList
	 */
	ListKafkaPartitions(ctx _context.Context, clusterId string, topicName string) (PartitionDataList, *_nethttp.Response, error)
}

type PartitionV3ApiService added in v0.3.8

type PartitionV3ApiService service

PartitionV3ApiService PartitionV3Api service

func (*PartitionV3ApiService) GetKafkaConsumerLag added in v0.3.8

func (a *PartitionV3ApiService) GetKafkaConsumerLag(ctx _context.Context, clusterId string, consumerGroupId string, topicName string, partitionId int32) (ConsumerLagData, *_nethttp.Response, error)

* GetKafkaConsumerLag Get Consumer Lag * * [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Cluster Admin for Kafka (v3)](https://img.shields.io/badge/-Request%20Access%20To%20Cluster%20Admin%20For%20Kafka%20v3-%23bc8540)](mailto:ccloud-rest-api+consumer-lag-earlyaccess@confluent.io?subject=Request%20to%20join%20v3%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cluster%20Admin%20For%20Kafka%20v3%20Early%20Access%20to%20provide%20early%20feedback%20on%20consumer%20lag%20apis%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Returns the consumer lag on a partition with the given `partition_id`. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param consumerGroupId The consumer group ID. * @param topicName The topic name. * @param partitionId The partition ID. * @return ConsumerLagData

func (*PartitionV3ApiService) GetKafkaPartition added in v0.3.8

func (a *PartitionV3ApiService) GetKafkaPartition(ctx _context.Context, clusterId string, topicName string, partitionId int32) (PartitionData, *_nethttp.Response, error)

* GetKafkaPartition Get Partition * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the partition with the given `partition_id`. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param topicName The topic name. * @param partitionId The partition ID. * @return PartitionData

func (*PartitionV3ApiService) ListKafkaPartitions added in v0.3.8

func (a *PartitionV3ApiService) ListKafkaPartitions(ctx _context.Context, clusterId string, topicName string) (PartitionDataList, *_nethttp.Response, error)

* ListKafkaPartitions List Partitions * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the list of partitions that belong to the specified topic. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param topicName The topic name. * @return PartitionDataList

type ProduceRequest added in v0.3.8

type ProduceRequest struct {
	PartitionId *int32                 `json:"partition_id,omitempty"`
	Headers     []ProduceRequestHeader `json:"headers,omitempty"`
	Key         *ProduceRequestData    `json:"key,omitempty"`
	Value       *ProduceRequestData    `json:"value,omitempty"`
	Timestamp   *time.Time             `json:"timestamp,omitempty"`
}

ProduceRequest struct for ProduceRequest

type ProduceRequestData added in v0.3.8

type ProduceRequestData struct {
	Type                string       `json:"type,omitempty"`
	Subject             *string      `json:"subject,omitempty"`
	SubjectNameStrategy *string      `json:"subject_name_strategy,omitempty"`
	SchemaId            *int32       `json:"schema_id,omitempty"`
	SchemaVersion       *int32       `json:"schema_version,omitempty"`
	Schema              *string      `json:"schema,omitempty"`
	Data                *interface{} `json:"data,omitempty"`
}

ProduceRequestData struct for ProduceRequestData

type ProduceRequestHeader added in v0.3.8

type ProduceRequestHeader struct {
	Name  string  `json:"name"`
	Value *string `json:"value,omitempty"`
}

ProduceRequestHeader struct for ProduceRequestHeader

type ProduceResponse added in v0.3.8

type ProduceResponse struct {
	ClusterId   string               `json:"cluster_id"`
	TopicName   string               `json:"topic_name"`
	PartitionId int32                `json:"partition_id"`
	Offset      int32                `json:"offset"`
	Timestamp   *time.Time           `json:"timestamp,omitempty"`
	Key         *ProduceResponseData `json:"key,omitempty"`
	Value       *ProduceResponseData `json:"value,omitempty"`
}

ProduceResponse struct for ProduceResponse

type ProduceResponseData added in v0.3.8

type ProduceResponseData struct {
	Size          int64   `json:"size"`
	Type          *string `json:"type,omitempty"`
	Subject       *string `json:"subject,omitempty"`
	SchemaId      *int32  `json:"schema_id,omitempty"`
	SchemaVersion *int32  `json:"schema_version,omitempty"`
}

ProduceResponseData struct for ProduceResponseData

type ReadKafkaMirrorTopicOpts added in v0.3.18

type ReadKafkaMirrorTopicOpts struct {
	IncludeStateTransitionErrors optional.Bool
}

ReadKafkaMirrorTopicOpts Optional parameters for the method 'ReadKafkaMirrorTopic'

type ReassignmentData

type ReassignmentData struct {
	Kind             string           `json:"kind"`
	Metadata         ResourceMetadata `json:"metadata"`
	ClusterId        string           `json:"cluster_id"`
	TopicName        string           `json:"topic_name"`
	PartitionId      int32            `json:"partition_id"`
	AddingReplicas   []int32          `json:"adding_replicas"`
	RemovingReplicas []int32          `json:"removing_replicas"`
	Replicas         Relationship     `json:"replicas"`
}

ReassignmentData struct for ReassignmentData

type ReassignmentDataAllOf

type ReassignmentDataAllOf struct {
	ClusterId        string       `json:"cluster_id"`
	TopicName        string       `json:"topic_name"`
	PartitionId      int32        `json:"partition_id"`
	AddingReplicas   []int32      `json:"adding_replicas"`
	RemovingReplicas []int32      `json:"removing_replicas"`
	Replicas         Relationship `json:"replicas"`
}

ReassignmentDataAllOf struct for ReassignmentDataAllOf

type ReassignmentDataList

type ReassignmentDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []ReassignmentData         `json:"data"`
}

ReassignmentDataList struct for ReassignmentDataList

type ReassignmentDataListAllOf

type ReassignmentDataListAllOf struct {
	Data []ReassignmentData `json:"data"`
}

ReassignmentDataListAllOf struct for ReassignmentDataListAllOf

type RecordsV3Api added in v0.3.15

type RecordsV3Api interface {

	/*
	 * ClustersClusterIdTopicsTopicNameRecordsPost Produce records to the given topic.
	 *
	 * [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Produce records to the given topic, returning delivery reports for each record produced. This API can be used in streaming mode by setting \"Transfer-Encoding: chunked\" header. For as long as the connection is kept open, the server will keep accepting records. For each record sent to the server, the server will asynchronously send back a delivery report, in the same order. Records are streamed to and from the server as Concatenated JSON. Errors are reported per record. The HTTP status code will be HTTP 200 OK as long as the connection is successfully established.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param topicName The topic name.
	 * @param optional nil or *ClustersClusterIdTopicsTopicNameRecordsPostOpts - Optional Parameters:
	 * @param "ProduceRequest" (optional.Interface of ProduceRequest) -  A single record to be produced to Kafka. To produce multiple records on the same connection, simply concatenate all the records, e.g.: {\"partition_id\":1}{\"partition_id\":2}. Delivery reports will be concatenated on the same order as the records are sent. See examples for the options available.
	 * @return ProduceResponse
	 */
	ClustersClusterIdTopicsTopicNameRecordsPost(ctx _context.Context, clusterId string, topicName string, localVarOptionals *ClustersClusterIdTopicsTopicNameRecordsPostOpts) (ProduceResponse, *_nethttp.Response, error)
}

type RecordsV3ApiService added in v0.3.15

type RecordsV3ApiService service

RecordsV3ApiService RecordsV3Api service

func (*RecordsV3ApiService) ClustersClusterIdTopicsTopicNameRecordsPost added in v0.3.15

func (a *RecordsV3ApiService) ClustersClusterIdTopicsTopicNameRecordsPost(ctx _context.Context, clusterId string, topicName string, localVarOptionals *ClustersClusterIdTopicsTopicNameRecordsPostOpts) (ProduceResponse, *_nethttp.Response, error)

* ClustersClusterIdTopicsTopicNameRecordsPost Produce records to the given topic. * * [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Produce records to the given topic, returning delivery reports for each record produced. This API can be used in streaming mode by setting \"Transfer-Encoding: chunked\" header. For as long as the connection is kept open, the server will keep accepting records. For each record sent to the server, the server will asynchronously send back a delivery report, in the same order. Records are streamed to and from the server as Concatenated JSON. Errors are reported per record. The HTTP status code will be HTTP 200 OK as long as the connection is successfully established. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param topicName The topic name. * @param optional nil or *ClustersClusterIdTopicsTopicNameRecordsPostOpts - Optional Parameters: * @param "ProduceRequest" (optional.Interface of ProduceRequest) - A single record to be produced to Kafka. To produce multiple records on the same connection, simply concatenate all the records, e.g.: {\"partition_id\":1}{\"partition_id\":2}. Delivery reports will be concatenated on the same order as the records are sent. See examples for the options available. * @return ProduceResponse

type Relationship

type Relationship struct {
	Related string `json:"related"`
}

Relationship struct for Relationship

type RemoveBrokerTaskApi

type RemoveBrokerTaskApi interface {

	/*
	 * ClustersClusterIdRemoveBrokerTasksBrokerIdGet Get Remove Broker Task
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Return the remove broker task for the specified ``broker_id``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param brokerId The Kafka broker ID.
	 * @return RemoveBrokerTaskData
	 */
	ClustersClusterIdRemoveBrokerTasksBrokerIdGet(ctx _context.Context, clusterId string, brokerId int32) (RemoveBrokerTaskData, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdRemoveBrokerTasksGet List Remove Broker Tasks
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns a list of remove-broker-tasks for the specified Kafka cluster. ``/remove-broker-tasks`` is deprecated and may be removed in a future release. Use the new ``/tasks`` API instead.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @return RemoveBrokerTaskDataList
	 */
	ClustersClusterIdRemoveBrokerTasksGet(ctx _context.Context, clusterId string) (RemoveBrokerTaskDataList, *_nethttp.Response, error)
}

type RemoveBrokerTaskApiService

type RemoveBrokerTaskApiService service

RemoveBrokerTaskApiService RemoveBrokerTaskApi service

func (*RemoveBrokerTaskApiService) ClustersClusterIdRemoveBrokerTasksBrokerIdGet

func (a *RemoveBrokerTaskApiService) ClustersClusterIdRemoveBrokerTasksBrokerIdGet(ctx _context.Context, clusterId string, brokerId int32) (RemoveBrokerTaskData, *_nethttp.Response, error)

* ClustersClusterIdRemoveBrokerTasksBrokerIdGet Get Remove Broker Task * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the remove broker task for the specified ``broker_id``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param brokerId The Kafka broker ID. * @return RemoveBrokerTaskData

func (*RemoveBrokerTaskApiService) ClustersClusterIdRemoveBrokerTasksGet

func (a *RemoveBrokerTaskApiService) ClustersClusterIdRemoveBrokerTasksGet(ctx _context.Context, clusterId string) (RemoveBrokerTaskDataList, *_nethttp.Response, error)

* ClustersClusterIdRemoveBrokerTasksGet List Remove Broker Tasks * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns a list of remove-broker-tasks for the specified Kafka cluster. ``/remove-broker-tasks`` is deprecated and may be removed in a future release. Use the new ``/tasks`` API instead. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @return RemoveBrokerTaskDataList

type RemoveBrokerTaskData

type RemoveBrokerTaskData struct {
	Kind                         string           `json:"kind"`
	Metadata                     ResourceMetadata `json:"metadata"`
	ClusterId                    string           `json:"cluster_id"`
	BrokerId                     int32            `json:"broker_id"`
	ShutdownScheduled            bool             `json:"shutdown_scheduled"`
	BrokerReplicaExclusionStatus string           `json:"broker_replica_exclusion_status"`
	PartitionReassignmentStatus  string           `json:"partition_reassignment_status"`
	BrokerShutdownStatus         string           `json:"broker_shutdown_status"`
	ErrorCode                    *int32           `json:"error_code,omitempty"`
	ErrorMessage                 *string          `json:"error_message,omitempty"`
	Broker                       Relationship     `json:"broker"`
}

RemoveBrokerTaskData struct for RemoveBrokerTaskData

type RemoveBrokerTaskDataAllOf

type RemoveBrokerTaskDataAllOf struct {
	ClusterId                    string       `json:"cluster_id"`
	BrokerId                     int32        `json:"broker_id"`
	ShutdownScheduled            bool         `json:"shutdown_scheduled"`
	BrokerReplicaExclusionStatus string       `json:"broker_replica_exclusion_status"`
	PartitionReassignmentStatus  string       `json:"partition_reassignment_status"`
	BrokerShutdownStatus         string       `json:"broker_shutdown_status"`
	ErrorCode                    *int32       `json:"error_code,omitempty"`
	ErrorMessage                 *string      `json:"error_message,omitempty"`
	Broker                       Relationship `json:"broker"`
}

RemoveBrokerTaskDataAllOf struct for RemoveBrokerTaskDataAllOf

type RemoveBrokerTaskDataList

type RemoveBrokerTaskDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []RemoveBrokerTaskData     `json:"data"`
}

RemoveBrokerTaskDataList struct for RemoveBrokerTaskDataList

type RemoveBrokerTaskDataListAllOf

type RemoveBrokerTaskDataListAllOf struct {
	Data []RemoveBrokerTaskData `json:"data"`
}

RemoveBrokerTaskDataListAllOf struct for RemoveBrokerTaskDataListAllOf

type RemoveBrokersRequestData

type RemoveBrokersRequestData struct {
	BrokerIds []int32 `json:"broker_ids"`
}

RemoveBrokersRequestData struct for RemoveBrokersRequestData

type ReplicaApi

type ReplicaApi interface {

	/*
	 * ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicasBrokerIdGet Get Replica
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns the replica for the specified partition assigned to the specified broker.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param topicName The topic name.
	 * @param partitionId The partition ID.
	 * @param brokerId The Kafka broker ID.
	 * @return ReplicaData
	 */
	ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicasBrokerIdGet(ctx _context.Context, clusterId string, topicName string, partitionId int32, brokerId int32) (ReplicaData, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicasGet List Replicas
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns the list of replicas for the specified partition.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param topicName The topic name.
	 * @param partitionId The partition ID.
	 * @return ReplicaDataList
	 */
	ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicasGet(ctx _context.Context, clusterId string, topicName string, partitionId int32) (ReplicaDataList, *_nethttp.Response, error)
}

type ReplicaApiService

type ReplicaApiService service

ReplicaApiService ReplicaApi service

func (*ReplicaApiService) ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicasBrokerIdGet

func (a *ReplicaApiService) ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicasBrokerIdGet(ctx _context.Context, clusterId string, topicName string, partitionId int32, brokerId int32) (ReplicaData, *_nethttp.Response, error)

* ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicasBrokerIdGet Get Replica * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the replica for the specified partition assigned to the specified broker. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param topicName The topic name. * @param partitionId The partition ID. * @param brokerId The Kafka broker ID. * @return ReplicaData

func (*ReplicaApiService) ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicasGet

func (a *ReplicaApiService) ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicasGet(ctx _context.Context, clusterId string, topicName string, partitionId int32) (ReplicaDataList, *_nethttp.Response, error)

* ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicasGet List Replicas * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the list of replicas for the specified partition. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param topicName The topic name. * @param partitionId The partition ID. * @return ReplicaDataList

type ReplicaData

type ReplicaData struct {
	Kind        string           `json:"kind"`
	Metadata    ResourceMetadata `json:"metadata"`
	ClusterId   string           `json:"cluster_id"`
	TopicName   string           `json:"topic_name"`
	PartitionId int32            `json:"partition_id"`
	BrokerId    int32            `json:"broker_id"`
	IsLeader    bool             `json:"is_leader"`
	IsInSync    bool             `json:"is_in_sync"`
	Broker      Relationship     `json:"broker"`
}

ReplicaData struct for ReplicaData

type ReplicaDataAllOf

type ReplicaDataAllOf struct {
	ClusterId   string       `json:"cluster_id"`
	TopicName   string       `json:"topic_name"`
	PartitionId int32        `json:"partition_id"`
	BrokerId    int32        `json:"broker_id"`
	IsLeader    bool         `json:"is_leader"`
	IsInSync    bool         `json:"is_in_sync"`
	Broker      Relationship `json:"broker"`
}

ReplicaDataAllOf struct for ReplicaDataAllOf

type ReplicaDataList

type ReplicaDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []ReplicaData              `json:"data"`
}

ReplicaDataList struct for ReplicaDataList

type ReplicaDataListAllOf

type ReplicaDataListAllOf struct {
	Data []ReplicaData `json:"data"`
}

ReplicaDataListAllOf struct for ReplicaDataListAllOf

type ReplicaStatusApi

type ReplicaStatusApi interface {

	/*
	 * ClustersClusterIdTopicsPartitionsReplicaStatusGet List All Replica Statuses from a cluster.
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Return the all the replica statuses for the specified ``cluster_id``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @return ReplicaStatusDataList
	 */
	ClustersClusterIdTopicsPartitionsReplicaStatusGet(ctx _context.Context, clusterId string) (ReplicaStatusDataList, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicaStatusGet List Partition Replica Statuses.
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Return the all the replica statuses for the specified ``topic_name`` and ``partition_id``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param topicName The topic name.
	 * @param partitionId The partition ID.
	 * @return ReplicaStatusDataList
	 */
	ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicaStatusGet(ctx _context.Context, clusterId string, topicName string, partitionId int32) (ReplicaStatusDataList, *_nethttp.Response, error)

	/*
	 * ClustersClusterIdTopicsTopicNamePartitionsReplicaStatusGet List All Partition Replica Statuses.
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Return the all the replica statuses for the specified ``topic_name``.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param topicName The topic name.
	 * @return ReplicaStatusDataList
	 */
	ClustersClusterIdTopicsTopicNamePartitionsReplicaStatusGet(ctx _context.Context, clusterId string, topicName string) (ReplicaStatusDataList, *_nethttp.Response, error)
}

type ReplicaStatusApiService

type ReplicaStatusApiService service

ReplicaStatusApiService ReplicaStatusApi service

func (*ReplicaStatusApiService) ClustersClusterIdTopicsPartitionsReplicaStatusGet added in v0.3.8

func (a *ReplicaStatusApiService) ClustersClusterIdTopicsPartitionsReplicaStatusGet(ctx _context.Context, clusterId string) (ReplicaStatusDataList, *_nethttp.Response, error)

* ClustersClusterIdTopicsPartitionsReplicaStatusGet List All Replica Statuses from a cluster. * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the all the replica statuses for the specified ``cluster_id``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @return ReplicaStatusDataList

func (*ReplicaStatusApiService) ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicaStatusGet

func (a *ReplicaStatusApiService) ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicaStatusGet(ctx _context.Context, clusterId string, topicName string, partitionId int32) (ReplicaStatusDataList, *_nethttp.Response, error)

* ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicaStatusGet List Partition Replica Statuses. * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the all the replica statuses for the specified ``topic_name`` and ``partition_id``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param topicName The topic name. * @param partitionId The partition ID. * @return ReplicaStatusDataList

func (*ReplicaStatusApiService) ClustersClusterIdTopicsTopicNamePartitionsReplicaStatusGet

func (a *ReplicaStatusApiService) ClustersClusterIdTopicsTopicNamePartitionsReplicaStatusGet(ctx _context.Context, clusterId string, topicName string) (ReplicaStatusDataList, *_nethttp.Response, error)

* ClustersClusterIdTopicsTopicNamePartitionsReplicaStatusGet List All Partition Replica Statuses. * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the all the replica statuses for the specified ``topic_name``. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param topicName The topic name. * @return ReplicaStatusDataList

type ReplicaStatusData

type ReplicaStatusData struct {
	Kind               string           `json:"kind"`
	Metadata           ResourceMetadata `json:"metadata"`
	ClusterId          string           `json:"cluster_id"`
	TopicName          string           `json:"topic_name"`
	BrokerId           int32            `json:"broker_id"`
	PartitionId        int32            `json:"partition_id"`
	IsLeader           bool             `json:"is_leader"`
	IsObserver         bool             `json:"is_observer"`
	IsIsrEligible      bool             `json:"is_isr_eligible"`
	IsInIsr            bool             `json:"is_in_isr"`
	IsCaughtUp         bool             `json:"is_caught_up"`
	LogStartOffset     int64            `json:"log_start_offset"`
	LogEndOffset       int64            `json:"log_end_offset"`
	LastCaughtUpTimeMs int64            `json:"last_caught_up_time_ms"`
	LastFetchTimeMs    int64            `json:"last_fetch_time_ms"`
	LinkName           string           `json:"link_name,omitempty"`
}

ReplicaStatusData struct for ReplicaStatusData

type ReplicaStatusDataAllOf

type ReplicaStatusDataAllOf struct {
	ClusterId          string `json:"cluster_id"`
	TopicName          string `json:"topic_name"`
	BrokerId           int32  `json:"broker_id"`
	PartitionId        int32  `json:"partition_id"`
	IsLeader           bool   `json:"is_leader"`
	IsObserver         bool   `json:"is_observer"`
	IsIsrEligible      bool   `json:"is_isr_eligible"`
	IsInIsr            bool   `json:"is_in_isr"`
	IsCaughtUp         bool   `json:"is_caught_up"`
	LogStartOffset     int64  `json:"log_start_offset"`
	LogEndOffset       int64  `json:"log_end_offset"`
	LastCaughtUpTimeMs int64  `json:"last_caught_up_time_ms"`
	LastFetchTimeMs    int64  `json:"last_fetch_time_ms"`
	LinkName           string `json:"link_name,omitempty"`
}

ReplicaStatusDataAllOf struct for ReplicaStatusDataAllOf

type ReplicaStatusDataList

type ReplicaStatusDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []ReplicaStatusData        `json:"data"`
}

ReplicaStatusDataList struct for ReplicaStatusDataList

type ReplicaStatusDataListAllOf

type ReplicaStatusDataListAllOf struct {
	Data []ReplicaStatusData `json:"data"`
}

ReplicaStatusDataListAllOf struct for ReplicaStatusDataListAllOf

type ReplicaV3Api added in v0.3.8

type ReplicaV3Api interface {

	/*
	 * ClustersClusterIdBrokersBrokerIdPartitionReplicasGet Search Replicas by Broker
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns the list of replicas assigned to the specified broker.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param brokerId The Kafka broker ID.
	 * @return ReplicaDataList
	 */
	ClustersClusterIdBrokersBrokerIdPartitionReplicasGet(ctx _context.Context, clusterId string, brokerId int32) (ReplicaDataList, *_nethttp.Response, error)
}

type ReplicaV3ApiService added in v0.3.8

type ReplicaV3ApiService service

ReplicaV3ApiService ReplicaV3Api service

func (*ReplicaV3ApiService) ClustersClusterIdBrokersBrokerIdPartitionReplicasGet added in v0.3.8

func (a *ReplicaV3ApiService) ClustersClusterIdBrokersBrokerIdPartitionReplicasGet(ctx _context.Context, clusterId string, brokerId int32) (ReplicaDataList, *_nethttp.Response, error)

* ClustersClusterIdBrokersBrokerIdPartitionReplicasGet Search Replicas by Broker * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the list of replicas assigned to the specified broker. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param brokerId The Kafka broker ID. * @return ReplicaDataList

type Resource

type Resource struct {
	Kind     string           `json:"kind"`
	Metadata ResourceMetadata `json:"metadata"`
}

Resource struct for Resource

type ResourceCollection

type ResourceCollection struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
}

ResourceCollection struct for ResourceCollection

type ResourceCollectionMetadata

type ResourceCollectionMetadata struct {
	Self string  `json:"self"`
	Next *string `json:"next,omitempty"`
}

ResourceCollectionMetadata struct for ResourceCollectionMetadata

type ResourceMetadata

type ResourceMetadata struct {
	Self         string  `json:"self"`
	ResourceName *string `json:"resource_name,omitempty"`
}

ResourceMetadata struct for ResourceMetadata

type ServerConfiguration

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type TopicConfigData

type TopicConfigData struct {
	Kind        string              `json:"kind"`
	Metadata    ResourceMetadata    `json:"metadata"`
	ClusterId   string              `json:"cluster_id"`
	Name        string              `json:"name"`
	Value       *string             `json:"value,omitempty"`
	IsDefault   bool                `json:"is_default"`
	IsReadOnly  bool                `json:"is_read_only"`
	IsSensitive bool                `json:"is_sensitive"`
	Source      string              `json:"source"`
	Synonyms    []ConfigSynonymData `json:"synonyms"`
	TopicName   string              `json:"topic_name"`
}

TopicConfigData struct for TopicConfigData

type TopicConfigDataAllOf

type TopicConfigDataAllOf struct {
	TopicName string `json:"topic_name"`
}

TopicConfigDataAllOf struct for TopicConfigDataAllOf

type TopicConfigDataList

type TopicConfigDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []TopicConfigData          `json:"data"`
}

TopicConfigDataList struct for TopicConfigDataList

type TopicConfigDataListAllOf

type TopicConfigDataListAllOf struct {
	Data []TopicConfigData `json:"data"`
}

TopicConfigDataListAllOf struct for TopicConfigDataListAllOf

type TopicData

type TopicData struct {
	Kind                   string           `json:"kind"`
	Metadata               ResourceMetadata `json:"metadata"`
	ClusterId              string           `json:"cluster_id"`
	TopicName              string           `json:"topic_name"`
	IsInternal             bool             `json:"is_internal"`
	ReplicationFactor      int32            `json:"replication_factor"`
	PartitionsCount        int32            `json:"partitions_count"`
	Partitions             Relationship     `json:"partitions"`
	Configs                Relationship     `json:"configs"`
	PartitionReassignments Relationship     `json:"partition_reassignments"`
}

TopicData struct for TopicData

type TopicDataAllOf

type TopicDataAllOf struct {
	ClusterId              string       `json:"cluster_id"`
	TopicName              string       `json:"topic_name"`
	IsInternal             bool         `json:"is_internal"`
	ReplicationFactor      int32        `json:"replication_factor"`
	PartitionsCount        int32        `json:"partitions_count"`
	Partitions             Relationship `json:"partitions"`
	Configs                Relationship `json:"configs"`
	PartitionReassignments Relationship `json:"partition_reassignments"`
}

TopicDataAllOf struct for TopicDataAllOf

type TopicDataList

type TopicDataList struct {
	Kind     string                     `json:"kind"`
	Metadata ResourceCollectionMetadata `json:"metadata"`
	Data     []TopicData                `json:"data"`
}

TopicDataList struct for TopicDataList

type TopicDataListAllOf

type TopicDataListAllOf struct {
	Data []TopicData `json:"data"`
}

TopicDataListAllOf struct for TopicDataListAllOf

type TopicList

type TopicList struct {
	Topics []string `json:"topics"`
}

TopicList struct for TopicList

type TopicV3Api added in v0.3.8

type TopicV3Api interface {

	/*
	 * CreateKafkaTopic Create Topic
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Creates a topic.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param optional nil or *CreateKafkaTopicOpts - Optional Parameters:
	 * @param "CreateTopicRequestData" (optional.Interface of CreateTopicRequestData) -  The topic creation request.
	 * @return TopicData
	 */
	CreateKafkaTopic(ctx _context.Context, clusterId string, localVarOptionals *CreateKafkaTopicOpts) (TopicData, *_nethttp.Response, error)

	/*
	 * DeleteKafkaTopic Delete Topic
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Deletes the topic with the given `topic_name`.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param topicName The topic name.
	 */
	DeleteKafkaTopic(ctx _context.Context, clusterId string, topicName string) (*_nethttp.Response, error)

	/*
	 * GetKafkaTopic Get Topic
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns the topic with the given `topic_name`.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param topicName The topic name.
	 * @return TopicData
	 */
	GetKafkaTopic(ctx _context.Context, clusterId string, topicName string) (TopicData, *_nethttp.Response, error)

	/*
	 * ListKafkaTopics List Topics
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Returns the list of topics that belong to the specified Kafka cluster.
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @return TopicDataList
	 */
	ListKafkaTopics(ctx _context.Context, clusterId string) (TopicDataList, *_nethttp.Response, error)
}

type TopicV3ApiService added in v0.3.8

type TopicV3ApiService service

TopicV3ApiService TopicV3Api service

func (*TopicV3ApiService) CreateKafkaTopic added in v0.3.8

func (a *TopicV3ApiService) CreateKafkaTopic(ctx _context.Context, clusterId string, localVarOptionals *CreateKafkaTopicOpts) (TopicData, *_nethttp.Response, error)

* CreateKafkaTopic Create Topic * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Creates a topic. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param optional nil or *CreateKafkaTopicOpts - Optional Parameters: * @param "CreateTopicRequestData" (optional.Interface of CreateTopicRequestData) - The topic creation request. * @return TopicData

func (*TopicV3ApiService) DeleteKafkaTopic added in v0.3.8

func (a *TopicV3ApiService) DeleteKafkaTopic(ctx _context.Context, clusterId string, topicName string) (*_nethttp.Response, error)

* DeleteKafkaTopic Delete Topic * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Deletes the topic with the given `topic_name`. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param topicName The topic name.

func (*TopicV3ApiService) GetKafkaTopic added in v0.3.8

func (a *TopicV3ApiService) GetKafkaTopic(ctx _context.Context, clusterId string, topicName string) (TopicData, *_nethttp.Response, error)

* GetKafkaTopic Get Topic * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the topic with the given `topic_name`. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param topicName The topic name. * @return TopicData

func (*TopicV3ApiService) ListKafkaTopics added in v0.3.8

func (a *TopicV3ApiService) ListKafkaTopics(ctx _context.Context, clusterId string) (TopicDataList, *_nethttp.Response, error)

* ListKafkaTopics List Topics * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Returns the list of topics that belong to the specified Kafka cluster. * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @return TopicDataList

type UnregisterBrokerData added in v0.3.15

type UnregisterBrokerData struct {
	ClusterId string `json:"cluster_id"`
	BrokerId  int32  `json:"broker_id"`
}

UnregisterBrokerData struct for UnregisterBrokerData

type UnregisterV3Api added in v0.3.15

type UnregisterV3Api interface {

	/*
	 * ClustersClusterIdBrokersBrokerIdunregisterPost Unregister a Broker
	 *
	 * Unregisters a broker from the cluster. This API is only supported for Kafka clusters running in KRaft mode. If run against a cluster running with ZooKeeper, a 400 response with an unsupported version error code will be returned (see BadRequestErrorResponse for more detail).
	 *
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param clusterId The Kafka cluster ID.
	 * @param brokerId The Kafka broker ID.
	 * @return UnregisterBrokerData
	 */
	ClustersClusterIdBrokersBrokerIdunregisterPost(ctx _context.Context, clusterId string, brokerId int32) (UnregisterBrokerData, *_nethttp.Response, error)
}

type UnregisterV3ApiService added in v0.3.15

type UnregisterV3ApiService service

UnregisterV3ApiService UnregisterV3Api service

func (*UnregisterV3ApiService) ClustersClusterIdBrokersBrokerIdunregisterPost added in v0.3.15

func (a *UnregisterV3ApiService) ClustersClusterIdBrokersBrokerIdunregisterPost(ctx _context.Context, clusterId string, brokerId int32) (UnregisterBrokerData, *_nethttp.Response, error)

* ClustersClusterIdBrokersBrokerIdunregisterPost Unregister a Broker * * Unregisters a broker from the cluster. This API is only supported for Kafka clusters running in KRaft mode. If run against a cluster running with ZooKeeper, a 400 response with an unsupported version error code will be returned (see BadRequestErrorResponse for more detail). * * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param clusterId The Kafka cluster ID. * @param brokerId The Kafka broker ID. * @return UnregisterBrokerData

type UpdateConfigRequestData

type UpdateConfigRequestData struct {
	Value *string `json:"value,omitempty"`
}

UpdateConfigRequestData struct for UpdateConfigRequestData

type UpdateKafkaClusterConfigOpts added in v0.3.8

type UpdateKafkaClusterConfigOpts struct {
	UpdateConfigRequestData optional.Interface
}

UpdateKafkaClusterConfigOpts Optional parameters for the method 'UpdateKafkaClusterConfig'

type UpdateKafkaClusterConfigsOpts added in v0.3.8

type UpdateKafkaClusterConfigsOpts struct {
	AlterConfigBatchRequestData optional.Interface
}

UpdateKafkaClusterConfigsOpts Optional parameters for the method 'UpdateKafkaClusterConfigs'

type UpdateKafkaLinkConfigBatchOpts added in v0.3.8

type UpdateKafkaLinkConfigBatchOpts struct {
	ValidateOnly                optional.Bool
	AlterConfigBatchRequestData optional.Interface
}

UpdateKafkaLinkConfigBatchOpts Optional parameters for the method 'UpdateKafkaLinkConfigBatch'

type UpdateKafkaLinkConfigOpts added in v0.3.8

type UpdateKafkaLinkConfigOpts struct {
	UpdateLinkConfigRequestData optional.Interface
}

UpdateKafkaLinkConfigOpts Optional parameters for the method 'UpdateKafkaLinkConfig'

type UpdateKafkaMirrorTopicsFailoverOpts added in v0.3.8

type UpdateKafkaMirrorTopicsFailoverOpts struct {
	ValidateOnly            optional.Bool
	AlterMirrorsRequestData optional.Interface
}

UpdateKafkaMirrorTopicsFailoverOpts Optional parameters for the method 'UpdateKafkaMirrorTopicsFailover'

type UpdateKafkaMirrorTopicsPauseOpts added in v0.3.8

type UpdateKafkaMirrorTopicsPauseOpts struct {
	ValidateOnly            optional.Bool
	AlterMirrorsRequestData optional.Interface
}

UpdateKafkaMirrorTopicsPauseOpts Optional parameters for the method 'UpdateKafkaMirrorTopicsPause'

type UpdateKafkaMirrorTopicsPromoteOpts added in v0.3.8

type UpdateKafkaMirrorTopicsPromoteOpts struct {
	ValidateOnly            optional.Bool
	AlterMirrorsRequestData optional.Interface
}

UpdateKafkaMirrorTopicsPromoteOpts Optional parameters for the method 'UpdateKafkaMirrorTopicsPromote'

type UpdateKafkaMirrorTopicsResumeOpts added in v0.3.8

type UpdateKafkaMirrorTopicsResumeOpts struct {
	ValidateOnly            optional.Bool
	AlterMirrorsRequestData optional.Interface
}

UpdateKafkaMirrorTopicsResumeOpts Optional parameters for the method 'UpdateKafkaMirrorTopicsResume'

type UpdateKafkaMirrorTopicsReverseAndPauseMirrorOpts added in v0.3.18

type UpdateKafkaMirrorTopicsReverseAndPauseMirrorOpts struct {
	ValidateOnly            optional.Bool
	AlterMirrorsRequestData optional.Interface
}

UpdateKafkaMirrorTopicsReverseAndPauseMirrorOpts Optional parameters for the method 'UpdateKafkaMirrorTopicsReverseAndPauseMirror'

type UpdateKafkaMirrorTopicsReverseAndStarMirrorOpts added in v0.3.18

type UpdateKafkaMirrorTopicsReverseAndStarMirrorOpts struct {
	ValidateOnly            optional.Bool
	AlterMirrorsRequestData optional.Interface
}

UpdateKafkaMirrorTopicsReverseAndStarMirrorOpts Optional parameters for the method 'UpdateKafkaMirrorTopicsReverseAndStarMirror'

type UpdateKafkaTopicConfigBatchOpts added in v0.3.8

type UpdateKafkaTopicConfigBatchOpts struct {
	AlterConfigBatchRequestData optional.Interface
}

UpdateKafkaTopicConfigBatchOpts Optional parameters for the method 'UpdateKafkaTopicConfigBatch'

type UpdateKafkaTopicConfigOpts added in v0.3.8

type UpdateKafkaTopicConfigOpts struct {
	UpdateConfigRequestData optional.Interface
}

UpdateKafkaTopicConfigOpts Optional parameters for the method 'UpdateKafkaTopicConfig'

type UpdateLinkConfigRequestData

type UpdateLinkConfigRequestData struct {
	Value string `json:"value"`
}

UpdateLinkConfigRequestData struct for UpdateLinkConfigRequestData

Source Files

Jump to

Keyboard shortcuts

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