v3

package
v0.3.0 Latest Latest
Warning

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

Go to latest
Published: Dec 1, 2021 License: Apache-2.0 Imports: 23 Imported by: 4

README

Go API client for v3

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 "./v3"

Documentation for API Endpoints

All URIs are relative to https://pkc-00000.region.provider.confluent.cloud

Class Method HTTP request Description
ACLV3Api CreateKafkaV3Acls Post /kafka/v3/clusters/{cluster_id}/acls Create ACLs
ACLV3Api DeleteKafkaV3Acls Delete /kafka/v3/clusters/{cluster_id}/acls Delete ACLs
ACLV3Api GetKafkaV3Acls Get /kafka/v3/clusters/{cluster_id}/acls Search ACLs
ClusterLinkingV3Api CreateKafkaV3Link Post /kafka/v3/clusters/{cluster_id}/links Create a cluster link
ClusterLinkingV3Api CreateKafkaV3MirrorTopic Post /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors Create a mirror topic
ClusterLinkingV3Api DeleteKafkaV3Link Delete /kafka/v3/clusters/{cluster_id}/links/{link_name} Delete the cluster link
ClusterLinkingV3Api DeleteKafkaV3LinkConfig Delete /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name} Reset the given config to default value
ClusterLinkingV3Api GetKafkaV3Link Get /kafka/v3/clusters/{cluster_id}/links/{link_name} Describe the cluster link
ClusterLinkingV3Api GetKafkaV3LinkConfigs Get /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name} Describe the config under the cluster link
ClusterLinkingV3Api ListKafkaV3LinkConfigs Get /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs List all configs of the cluster link
ClusterLinkingV3Api ListKafkaV3Links Get /kafka/v3/clusters/{cluster_id}/links List all cluster links in the dest cluster
ClusterLinkingV3Api ListKafkaV3MirrorTopics Get /kafka/v3/clusters/{cluster_id}/links/-/mirrors List mirror topics
ClusterLinkingV3Api ListKafkaV3MirrorTopicsUnderLink Get /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors List mirror topics
ClusterLinkingV3Api ReadKafkaV3MirrorTopic Get /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors/{mirror_topic_name} Describe the mirror topic
ClusterLinkingV3Api UpdateKafkaV3LinkConfig Put /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name} Alter the config under the cluster link
ClusterLinkingV3Api UpdateKafkaV3LinkConfigBatch Post /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs:alter Batch Alter Topic Configs
ClusterLinkingV3Api UpdateKafkaV3MirrorTopicsFailover Post /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:failover Failover the mirror topics
ClusterLinkingV3Api UpdateKafkaV3MirrorTopicsPause Post /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:pause Pause the mirror topics
ClusterLinkingV3Api UpdateKafkaV3MirrorTopicsPromote Post /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:promote Promote the mirror topics
ClusterLinkingV3Api UpdateKafkaV3MirrorTopicsResume Post /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:resume Resume the mirror topics
ClusterV3Api GetKafkaV3Cluster Get /kafka/v3/clusters/{cluster_id} Get Cluster
ConfigsApi ListKafkaV3DefaultTopicConfigs Get /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/default-configs List Default Topic Configs
ConfigsV3Api DeleteKafkaV3ClusterConfig Delete /kafka/v3/clusters/{cluster_id}/broker-configs/{name} Reset Cluster Config
ConfigsV3Api DeleteKafkaV3TopicConfig Delete /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name} Reset Topic Config
ConfigsV3Api GetKafkaV3ClusterConfig Get /kafka/v3/clusters/{cluster_id}/broker-configs/{name} Get Cluster Config
ConfigsV3Api GetKafkaV3TopicConfig Get /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name} Get Topic Config
ConfigsV3Api ListKafkaV3AllTopicConfigs Get /kafka/v3/clusters/{cluster_id}/topics/-/configs Get All Topic Configs
ConfigsV3Api ListKafkaV3ClusterConfigs Get /kafka/v3/clusters/{cluster_id}/broker-configs List Cluster Configs
ConfigsV3Api ListKafkaV3TopicConfigs Get /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs List Topic Configs
ConfigsV3Api UpdateKafkaV3ClusterConfig Put /kafka/v3/clusters/{cluster_id}/broker-configs/{name} Update Cluster Config
ConfigsV3Api UpdateKafkaV3ClusterConfigs Post /kafka/v3/clusters/{cluster_id}/broker-configs:alter Batch Alter Cluster Configs
ConfigsV3Api UpdateKafkaV3TopicConfig Put /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name} Update Topic Config
ConfigsV3Api UpdateKafkaV3TopicConfigBatch Post /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs:alter Batch Alter Topic Configs
ConsumerGroupV3Api GetKafkaV3Consumer Get /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id} Get Consumer
ConsumerGroupV3Api GetKafkaV3ConsumerGroup Get /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id} Get Consumer Group
ConsumerGroupV3Api GetKafkaV3ConsumerGroupLagSummary Get /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary Get Consumer Group Lag Summary.
ConsumerGroupV3Api ListKafkaV3ConsumerGroups Get /kafka/v3/clusters/{cluster_id}/consumer-groups List Consumer Groups
ConsumerGroupV3Api ListKafkaV3ConsumerLags Get /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags List Consumer Lags
ConsumerGroupV3Api ListKafkaV3Consumers Get /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers List Consumers
PartitionV3Api GetKafkaV3ConsumerLag Get /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags/{topic_name}/partitions/{partition_id} Get Consumer Lag
PartitionV3Api GetKafkaV3Partition Get /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id} Get Partition
PartitionV3Api ListKafkaV3Partitions Get /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions List Partitions
TopicV3Api CreateKafkaV3Topic Post /kafka/v3/clusters/{cluster_id}/topics Create Topic
TopicV3Api DeleteKafkaV3Topic Delete /kafka/v3/clusters/{cluster_id}/topics/{topic_name} Delete Topic
TopicV3Api GetKafkaV3Topic Get /kafka/v3/clusters/{cluster_id}/topics/{topic_name} Get Topic
TopicV3Api ListKafkaV3Topics Get /kafka/v3/clusters/{cluster_id}/topics List Topics

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

type ACLV3Api interface {

	/*
	 * CreateKafkaV3Acls 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 *CreateKafkaV3AclsOpts - Optional Parameters:
	 * @param "CreateAclRequestData" (optional.Interface of CreateAclRequestData) -  The ACL creation request.
	 */
	CreateKafkaV3Acls(ctx _context.Context, clusterId string, localVarOptionals *CreateKafkaV3AclsOpts) (*_nethttp.Response, error)

	/*
	 * DeleteKafkaV3Acls 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 *DeleteKafkaV3AclsOpts - Optional Parameters:
	 * @param "ResourceType" (optional.Interface of AclResourceType) -  The ACL resource type.
	 * @param "ResourceName" (optional.String) -  The ACL resource name.
	 * @param "PatternType" (optional.Interface of AclPatternType) -  The ACL pattern type.
	 * @param "Principal" (optional.String) -  The ACL principal.
	 * @param "Host" (optional.String) -  The ACL host.
	 * @param "Operation" (optional.Interface of AclOperation) -  The ACL operation.
	 * @param "Permission" (optional.Interface of AclPermission) -  The ACL permission.
	 * @return InlineResponse200
	 */
	DeleteKafkaV3Acls(ctx _context.Context, clusterId string, localVarOptionals *DeleteKafkaV3AclsOpts) (InlineResponse200, *_nethttp.Response, error)

	/*
	 * GetKafkaV3Acls 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 *GetKafkaV3AclsOpts - Optional Parameters:
	 * @param "ResourceType" (optional.Interface of AclResourceType) -  The ACL resource type.
	 * @param "ResourceName" (optional.String) -  The ACL resource name.
	 * @param "PatternType" (optional.Interface of AclPatternType) -  The ACL pattern type.
	 * @param "Principal" (optional.String) -  The ACL principal.
	 * @param "Host" (optional.String) -  The ACL host.
	 * @param "Operation" (optional.Interface of AclOperation) -  The ACL operation.
	 * @param "Permission" (optional.Interface of AclPermission) -  The ACL permission.
	 * @return AclDataList
	 */
	GetKafkaV3Acls(ctx _context.Context, clusterId string, localVarOptionals *GetKafkaV3AclsOpts) (AclDataList, *_nethttp.Response, error)
}

type ACLV3ApiService

type ACLV3ApiService service

ACLV3ApiService ACLV3Api service

func (*ACLV3ApiService) CreateKafkaV3Acls

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

* CreateKafkaV3Acls 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 *CreateKafkaV3AclsOpts - Optional Parameters: * @param "CreateAclRequestData" (optional.Interface of CreateAclRequestData) - The ACL creation request.

func (*ACLV3ApiService) DeleteKafkaV3Acls

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

* DeleteKafkaV3Acls 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 *DeleteKafkaV3AclsOpts - Optional Parameters: * @param "ResourceType" (optional.Interface of AclResourceType) - The ACL resource type. * @param "ResourceName" (optional.String) - The ACL resource name. * @param "PatternType" (optional.Interface of AclPatternType) - The ACL pattern type. * @param "Principal" (optional.String) - The ACL principal. * @param "Host" (optional.String) - The ACL host. * @param "Operation" (optional.Interface of AclOperation) - The ACL operation. * @param "Permission" (optional.Interface of AclPermission) - The ACL permission. * @return InlineResponse200

func (*ACLV3ApiService) GetKafkaV3Acls

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

* GetKafkaV3Acls 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 *GetKafkaV3AclsOpts - Optional Parameters: * @param "ResourceType" (optional.Interface of AclResourceType) - The ACL resource type. * @param "ResourceName" (optional.String) - The ACL resource name. * @param "PatternType" (optional.Interface of AclPatternType) - The ACL pattern type. * @param "Principal" (optional.String) - The ACL principal. * @param "Host" (optional.String) - The ACL host. * @param "Operation" (optional.Interface of AclOperation) - The ACL operation. * @param "Permission" (optional.Interface of AclPermission) - The ACL permission. * @return AclDataList

type APIClient

type APIClient struct {
	ACLV3Api ACLV3Api

	ClusterLinkingV3Api ClusterLinkingV3Api

	ClusterV3Api ClusterV3Api

	ConfigsApi ConfigsApi

	ConfigsV3Api ConfigsV3Api

	ConsumerGroupV3Api ConsumerGroupV3Api

	PartitionV3Api PartitionV3Api

	TopicV3Api TopicV3Api
	// 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      ConfigSource        `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      ConfigSource        `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  AclPatternType   `json:"pattern_type"`
	Principal    string           `json:"principal"`
	Host         string           `json:"host"`
	Operation    AclOperation     `json:"operation"`
	Permission   AclPermission    `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  AclPatternType  `json:"pattern_type"`
	Principal    string          `json:"principal"`
	Host         string          `json:"host"`
	Operation    AclOperation    `json:"operation"`
	Permission   AclPermission   `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 AclOperation

type AclOperation string

AclOperation the model 'AclOperation'

const (
	ACLOPERATION_UNKNOWN          AclOperation = "UNKNOWN"
	ACLOPERATION_ANY              AclOperation = "ANY"
	ACLOPERATION_ALL              AclOperation = "ALL"
	ACLOPERATION_READ             AclOperation = "READ"
	ACLOPERATION_WRITE            AclOperation = "WRITE"
	ACLOPERATION_CREATE           AclOperation = "CREATE"
	ACLOPERATION_DELETE           AclOperation = "DELETE"
	ACLOPERATION_ALTER            AclOperation = "ALTER"
	ACLOPERATION_DESCRIBE         AclOperation = "DESCRIBE"
	ACLOPERATION_CLUSTER_ACTION   AclOperation = "CLUSTER_ACTION"
	ACLOPERATION_DESCRIBE_CONFIGS AclOperation = "DESCRIBE_CONFIGS"
	ACLOPERATION_ALTER_CONFIGS    AclOperation = "ALTER_CONFIGS"
	ACLOPERATION_IDEMPOTENT_WRITE AclOperation = "IDEMPOTENT_WRITE"
)

List of AclOperation

type AclPatternType

type AclPatternType string

AclPatternType the model 'AclPatternType'

const (
	ACLPATTERNTYPE_UNKNOWN  AclPatternType = "UNKNOWN"
	ACLPATTERNTYPE_ANY      AclPatternType = "ANY"
	ACLPATTERNTYPE_MATCH    AclPatternType = "MATCH"
	ACLPATTERNTYPE_LITERAL  AclPatternType = "LITERAL"
	ACLPATTERNTYPE_PREFIXED AclPatternType = "PREFIXED"
)

List of AclPatternType

type AclPermission

type AclPermission string

AclPermission the model 'AclPermission'

const (
	ACLPERMISSION_UNKNOWN AclPermission = "UNKNOWN"
	ACLPERMISSION_ANY     AclPermission = "ANY"
	ACLPERMISSION_DENY    AclPermission = "DENY"
	ACLPERMISSION_ALLOW   AclPermission = "ALLOW"
)

List of AclPermission

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

type AlterBrokerReplicaExclusionData struct {
	Kind         string           `json:"kind"`
	Metadata     ResourceMetadata `json:"metadata"`
	ClusterId    string           `json:"cluster_id"`
	BrokerId     int32            `json:"broker_id"`
	Exclusion    ExclusionOp      `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

type AlterBrokerReplicaExclusionDataAllOf struct {
	ClusterId    string       `json:"cluster_id"`
	BrokerId     int32        `json:"broker_id"`
	Exclusion    ExclusionOp  `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

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

AlterBrokerReplicaExclusionDataList struct for AlterBrokerReplicaExclusionDataList

type AlterBrokerReplicaExclusionDataListAllOf

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      MirrorLags       `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      MirrorLags `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 {
	MirrorTopicNames []string `json:"mirror_topic_names"`
}

AlterMirrorsRequestData struct for AlterMirrorsRequestData

type AnyUnevenLoadData

type AnyUnevenLoadData struct {
	Kind           string              `json:"kind"`
	Metadata       ResourceMetadata    `json:"metadata"`
	ClusterId      string              `json:"cluster_id"`
	Status         AnyUnevenLoadStatus `json:"status"`
	PreviousStatus AnyUnevenLoadStatus `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         AnyUnevenLoadStatus `json:"status"`
	PreviousStatus AnyUnevenLoadStatus `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 AnyUnevenLoadStatus

type AnyUnevenLoadStatus string

AnyUnevenLoadStatus the model 'AnyUnevenLoadStatus'

const (
	ANYUNEVENLOADSTATUS_STARTING         AnyUnevenLoadStatus = "STARTING"
	ANYUNEVENLOADSTATUS_BALANCING        AnyUnevenLoadStatus = "BALANCING"
	ANYUNEVENLOADSTATUS_BALANCED         AnyUnevenLoadStatus = "BALANCED"
	ANYUNEVENLOADSTATUS_BALANCING_FAILED AnyUnevenLoadStatus = "BALANCING_FAILED"
	ANYUNEVENLOADSTATUS_DISABLED         AnyUnevenLoadStatus = "DISABLED"
	ANYUNEVENLOADSTATUS_ABORTED          AnyUnevenLoadStatus = "ABORTED"
	ANYUNEVENLOADSTATUS_UNKNOWN          AnyUnevenLoadStatus = "UNKNOWN"
)

List of AnyUnevenLoadStatus

type BalancerStatus

type BalancerStatus string

BalancerStatus the model 'BalancerStatus'

const (
	BALANCERSTATUS_BOOTSTRAPPING BalancerStatus = "BOOTSTRAPPING"
	BALANCERSTATUS_STARTING      BalancerStatus = "STARTING"
	BALANCERSTATUS_ENABLED       BalancerStatus = "ENABLED"
	BALANCERSTATUS_ERROR         BalancerStatus = "ERROR"
	BALANCERSTATUS_DISABLED      BalancerStatus = "DISABLED"
	BALANCERSTATUS_FAILOVER      BalancerStatus = "FAILOVER"
	BALANCERSTATUS_LOAD_FAILURE  BalancerStatus = "LOAD_FAILURE"
	BALANCERSTATUS_UNKNOWN       BalancerStatus = "UNKNOWN"
)

List of BalancerStatus

type BalancerStatusData

type BalancerStatusData struct {
	Kind          string           `json:"kind"`
	Metadata      ResourceMetadata `json:"metadata"`
	ClusterId     string           `json:"cluster_id"`
	Status        BalancerStatus   `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        BalancerStatus `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 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 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      ConfigSource        `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 BrokerReplicaExclusionBatchRequestData

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

BrokerReplicaExclusionBatchRequestData struct for BrokerReplicaExclusionBatchRequestData

type BrokerReplicaExclusionData

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

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

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

BrokerReplicaExclusionDataList struct for BrokerReplicaExclusionDataList

type BrokerReplicaExclusionDataListAllOf

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

BrokerReplicaExclusionDataListAllOf struct for BrokerReplicaExclusionDataListAllOf

type BrokerReplicaExclusionRequestData

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

BrokerReplicaExclusionRequestData struct for BrokerReplicaExclusionRequestData

type BrokerReplicaExclusionStatus

type BrokerReplicaExclusionStatus string

BrokerReplicaExclusionStatus the model 'BrokerReplicaExclusionStatus'

const (
	BROKERREPLICAEXCLUSIONSTATUS_PENDING     BrokerReplicaExclusionStatus = "PENDING"
	BROKERREPLICAEXCLUSIONSTATUS_IN_PROGRESS BrokerReplicaExclusionStatus = "IN_PROGRESS"
	BROKERREPLICAEXCLUSIONSTATUS_EXCLUDED    BrokerReplicaExclusionStatus = "EXCLUDED"
	BROKERREPLICAEXCLUSIONSTATUS_REMOVING    BrokerReplicaExclusionStatus = "REMOVING"
	BROKERREPLICAEXCLUSIONSTATUS_ERROR       BrokerReplicaExclusionStatus = "ERROR"
	BROKERREPLICAEXCLUSIONSTATUS_CANCELED    BrokerReplicaExclusionStatus = "CANCELED"
	BROKERREPLICAEXCLUSIONSTATUS_COMPLETED   BrokerReplicaExclusionStatus = "COMPLETED"
	BROKERREPLICAEXCLUSIONSTATUS_UNKNOWN     BrokerReplicaExclusionStatus = "UNKNOWN"
)

List of BrokerReplicaExclusionStatus

type BrokerShutdownStatus

type BrokerShutdownStatus string

BrokerShutdownStatus the model 'BrokerShutdownStatus'

const (
	BROKERSHUTDOWNSTATUS_ERROR       BrokerShutdownStatus = "ERROR"
	BROKERSHUTDOWNSTATUS_CANCELED    BrokerShutdownStatus = "CANCELED"
	BROKERSHUTDOWNSTATUS_PENDING     BrokerShutdownStatus = "PENDING"
	BROKERSHUTDOWNSTATUS_IN_PROGRESS BrokerShutdownStatus = "IN_PROGRESS"
	BROKERSHUTDOWNSTATUS_COMPLETED   BrokerShutdownStatus = "COMPLETED"
	BROKERSHUTDOWNSTATUS_UNKNOWN     BrokerShutdownStatus = "UNKNOWN"
)

List of BrokerShutdownStatus

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        BrokerTaskStatus  `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        BrokerTaskStatus  `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 BrokerTaskStatus

type BrokerTaskStatus string

BrokerTaskStatus the model 'BrokerTaskStatus'

const (
	BROKERTASKSTATUS_FAILED      BrokerTaskStatus = "FAILED"
	BROKERTASKSTATUS_IN_PROGRESS BrokerTaskStatus = "IN_PROGRESS"
	BROKERTASKSTATUS_SUCCESS     BrokerTaskStatus = "SUCCESS"
	BROKERTASKSTATUS_UNKNOWN     BrokerTaskStatus = "UNKNOWN"
)

List of BrokerTaskStatus

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 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      ConfigSource        `json:"source"`
	Synonyms    []ConfigSynonymData `json:"synonyms"`
	ConfigType  ClusterConfigType   `json:"config_type"`
}

ClusterConfigData struct for ClusterConfigData

type ClusterConfigDataAllOf

type ClusterConfigDataAllOf struct {
	ConfigType ClusterConfigType `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 ClusterConfigType

type ClusterConfigType string

ClusterConfigType the model 'ClusterConfigType'

const (
	CLUSTERCONFIGTYPE_BROKER ClusterConfigType = "BROKER"
)

List of ClusterConfigType

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

type ClusterLinkingV3Api interface {

	/*
	 * CreateKafkaV3Link Create a 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 optional nil or *CreateKafkaV3LinkOpts - Optional Parameters:
	 * @param "CreateLinkRequestData" (optional.Interface of CreateLinkRequestData) -  Create a cluster link
	 */
	CreateKafkaV3Link(ctx _context.Context, clusterId string, localVarOptionals *CreateKafkaV3LinkOpts) (*_nethttp.Response, error)

	/*
	 * CreateKafkaV3MirrorTopic 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 *CreateKafkaV3MirrorTopicOpts - Optional Parameters:
	 * @param "CreateMirrorTopicRequestData" (optional.Interface of CreateMirrorTopicRequestData) -  Name and configs of the topics mirroring from and mirroring to
	 */
	CreateKafkaV3MirrorTopic(ctx _context.Context, clusterId string, linkName string, localVarOptionals *CreateKafkaV3MirrorTopicOpts) (*_nethttp.Response, error)

	/*
	 * DeleteKafkaV3Link 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
	 */
	DeleteKafkaV3Link(ctx _context.Context, clusterId string, linkName string) (*_nethttp.Response, error)

	/*
	 * DeleteKafkaV3LinkConfig 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
	 */
	DeleteKafkaV3LinkConfig(ctx _context.Context, clusterId string, linkName string, configName string) (*_nethttp.Response, error)

	/*
	 * GetKafkaV3Link Describe 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 ListLinksResponseData
	 */
	GetKafkaV3Link(ctx _context.Context, clusterId string, linkName string) (ListLinksResponseData, *_nethttp.Response, error)

	/*
	 * GetKafkaV3LinkConfigs 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
	 */
	GetKafkaV3LinkConfigs(ctx _context.Context, clusterId string, linkName string, configName string) (ListLinkConfigsResponseData, *_nethttp.Response, error)

	/*
	 * ListKafkaV3LinkConfigs 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
	 */
	ListKafkaV3LinkConfigs(ctx _context.Context, clusterId string, linkName string) (ListLinkConfigsResponseDataList, *_nethttp.Response, error)

	/*
	 * ListKafkaV3Links 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)
	 *
	 * @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
	 */
	ListKafkaV3Links(ctx _context.Context, clusterId string) (ListLinksResponseDataList, *_nethttp.Response, error)

	/*
	 * ListKafkaV3MirrorTopics 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 *ListKafkaV3MirrorTopicsOpts - 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
	 */
	ListKafkaV3MirrorTopics(ctx _context.Context, clusterId string, localVarOptionals *ListKafkaV3MirrorTopicsOpts) (ListMirrorTopicsResponseDataList, *_nethttp.Response, error)

	/*
	 * ListKafkaV3MirrorTopicsUnderLink 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 *ListKafkaV3MirrorTopicsUnderLinkOpts - 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
	 */
	ListKafkaV3MirrorTopicsUnderLink(ctx _context.Context, clusterId string, linkName string, localVarOptionals *ListKafkaV3MirrorTopicsUnderLinkOpts) (ListMirrorTopicsResponseDataList, *_nethttp.Response, error)

	/*
	 * ReadKafkaV3MirrorTopic 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
	 * @return ListMirrorTopicsResponseData
	 */
	ReadKafkaV3MirrorTopic(ctx _context.Context, clusterId string, linkName string, mirrorTopicName string) (ListMirrorTopicsResponseData, *_nethttp.Response, error)

	/*
	 * UpdateKafkaV3LinkConfig 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 *UpdateKafkaV3LinkConfigOpts - Optional Parameters:
	 * @param "UpdateLinkConfigRequestData" (optional.Interface of UpdateLinkConfigRequestData) -  Link config value to update
	 */
	UpdateKafkaV3LinkConfig(ctx _context.Context, clusterId string, linkName string, configName string, localVarOptionals *UpdateKafkaV3LinkConfigOpts) (*_nethttp.Response, error)

	/*
	 * UpdateKafkaV3LinkConfigBatch Batch Alter Topic Configs
	 *
	 * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)  Batch Alter 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 *UpdateKafkaV3LinkConfigBatchOpts - Optional Parameters:
	 * @param "AlterConfigBatchRequestData" (optional.Interface of AlterConfigBatchRequestData) -
	 */
	UpdateKafkaV3LinkConfigBatch(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaV3LinkConfigBatchOpts) (*_nethttp.Response, error)

	/*
	 * UpdateKafkaV3MirrorTopicsFailover 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 *UpdateKafkaV3MirrorTopicsFailoverOpts - Optional Parameters:
	 * @param "ValidateOnly" (optional.Bool) -  To validate if the link can be created or not, but not to create it. Default: false
	 * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) -  Name of the topics to apply the changes
	 * @return AlterMirrorStatusResponseDataList
	 */
	UpdateKafkaV3MirrorTopicsFailover(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaV3MirrorTopicsFailoverOpts) (AlterMirrorStatusResponseDataList, *_nethttp.Response, error)

	/*
	 * UpdateKafkaV3MirrorTopicsPause 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 *UpdateKafkaV3MirrorTopicsPauseOpts - Optional Parameters:
	 * @param "ValidateOnly" (optional.Bool) -  To validate if the link can be created or not, but not to create it. Default: false
	 * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) -  Name of the topics to apply the changes
	 * @return AlterMirrorStatusResponseDataList
	 */
	UpdateKafkaV3MirrorTopicsPause(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaV3MirrorTopicsPauseOpts) (AlterMirrorStatusResponseDataList, *_nethttp.Response, error)

	/*
	 * UpdateKafkaV3MirrorTopicsPromote 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 *UpdateKafkaV3MirrorTopicsPromoteOpts - Optional Parameters:
	 * @param "ValidateOnly" (optional.Bool) -  To validate if the link can be created or not, but not to create it. Default: false
	 * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) -  Name of the topics to apply the changes
	 * @return AlterMirrorStatusResponseDataList
	 */
	UpdateKafkaV3MirrorTopicsPromote(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaV3MirrorTopicsPromoteOpts) (AlterMirrorStatusResponseDataList, *_nethttp.Response, error)

	/*
	 * UpdateKafkaV3MirrorTopicsResume 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 *UpdateKafkaV3MirrorTopicsResumeOpts - Optional Parameters:
	 * @param "ValidateOnly" (optional.Bool) -  To validate if the link can be created or not, but not to create it. Default: false
	 * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) -  Name of the topics to apply the changes
	 * @return AlterMirrorStatusResponseDataList
	 */
	UpdateKafkaV3MirrorTopicsResume(ctx _context.Context, clusterId string, linkName string, localVarOptionals *UpdateKafkaV3MirrorTopicsResumeOpts) (AlterMirrorStatusResponseDataList, *_nethttp.Response, error)
}

type ClusterLinkingV3ApiService

type ClusterLinkingV3ApiService service

ClusterLinkingV3ApiService ClusterLinkingV3Api service

func (a *ClusterLinkingV3ApiService) CreateKafkaV3Link(ctx _context.Context, clusterId string, localVarOptionals *CreateKafkaV3LinkOpts) (*_nethttp.Response, error)

* CreateKafkaV3Link Create a 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 optional nil or *CreateKafkaV3LinkOpts - Optional Parameters: * @param "CreateLinkRequestData" (optional.Interface of CreateLinkRequestData) - Create a cluster link

func (*ClusterLinkingV3ApiService) CreateKafkaV3MirrorTopic

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

* CreateKafkaV3MirrorTopic 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 *CreateKafkaV3MirrorTopicOpts - Optional Parameters: * @param "CreateMirrorTopicRequestData" (optional.Interface of CreateMirrorTopicRequestData) - Name and configs of the topics mirroring from and mirroring to

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

* DeleteKafkaV3Link 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

func (*ClusterLinkingV3ApiService) DeleteKafkaV3LinkConfig

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

* DeleteKafkaV3LinkConfig 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) GetKafkaV3Link(ctx _context.Context, clusterId string, linkName string) (ListLinksResponseData, *_nethttp.Response, error)

* GetKafkaV3Link Describe 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 ListLinksResponseData

func (*ClusterLinkingV3ApiService) GetKafkaV3LinkConfigs

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

* GetKafkaV3LinkConfigs 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) ListKafkaV3LinkConfigs

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

* ListKafkaV3LinkConfigs 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

* ListKafkaV3Links 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) * * @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) ListKafkaV3MirrorTopics

func (a *ClusterLinkingV3ApiService) ListKafkaV3MirrorTopics(ctx _context.Context, clusterId string, localVarOptionals *ListKafkaV3MirrorTopicsOpts) (ListMirrorTopicsResponseDataList, *_nethttp.Response, error)

* ListKafkaV3MirrorTopics 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 *ListKafkaV3MirrorTopicsOpts - 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) ListKafkaV3MirrorTopicsUnderLink(ctx _context.Context, clusterId string, linkName string, localVarOptionals *ListKafkaV3MirrorTopicsUnderLinkOpts) (ListMirrorTopicsResponseDataList, *_nethttp.Response, error)

* ListKafkaV3MirrorTopicsUnderLink 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 *ListKafkaV3MirrorTopicsUnderLinkOpts - 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) ReadKafkaV3MirrorTopic

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

* ReadKafkaV3MirrorTopic 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 * @return ListMirrorTopicsResponseData

func (*ClusterLinkingV3ApiService) UpdateKafkaV3LinkConfig

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

* UpdateKafkaV3LinkConfig 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 *UpdateKafkaV3LinkConfigOpts - Optional Parameters: * @param "UpdateLinkConfigRequestData" (optional.Interface of UpdateLinkConfigRequestData) - Link config value to update

func (*ClusterLinkingV3ApiService) UpdateKafkaV3LinkConfigBatch

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

* UpdateKafkaV3LinkConfigBatch Batch Alter Topic Configs * * [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Batch Alter 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 *UpdateKafkaV3LinkConfigBatchOpts - Optional Parameters: * @param "AlterConfigBatchRequestData" (optional.Interface of AlterConfigBatchRequestData) -

func (*ClusterLinkingV3ApiService) UpdateKafkaV3MirrorTopicsFailover

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

* UpdateKafkaV3MirrorTopicsFailover 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 *UpdateKafkaV3MirrorTopicsFailoverOpts - Optional Parameters: * @param "ValidateOnly" (optional.Bool) - To validate if the link can be created or not, but not to create it. Default: false * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) - Name of the topics to apply the changes * @return AlterMirrorStatusResponseDataList

func (*ClusterLinkingV3ApiService) UpdateKafkaV3MirrorTopicsPause

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

* UpdateKafkaV3MirrorTopicsPause 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 *UpdateKafkaV3MirrorTopicsPauseOpts - Optional Parameters: * @param "ValidateOnly" (optional.Bool) - To validate if the link can be created or not, but not to create it. Default: false * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) - Name of the topics to apply the changes * @return AlterMirrorStatusResponseDataList

func (*ClusterLinkingV3ApiService) UpdateKafkaV3MirrorTopicsPromote

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

* UpdateKafkaV3MirrorTopicsPromote 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 *UpdateKafkaV3MirrorTopicsPromoteOpts - Optional Parameters: * @param "ValidateOnly" (optional.Bool) - To validate if the link can be created or not, but not to create it. Default: false * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) - Name of the topics to apply the changes * @return AlterMirrorStatusResponseDataList

func (*ClusterLinkingV3ApiService) UpdateKafkaV3MirrorTopicsResume

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

* UpdateKafkaV3MirrorTopicsResume 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 *UpdateKafkaV3MirrorTopicsResumeOpts - Optional Parameters: * @param "ValidateOnly" (optional.Bool) - To validate if the link can be created or not, but not to create it. Default: false * @param "AlterMirrorsRequestData" (optional.Interface of AlterMirrorsRequestData) - Name of the topics to apply the changes * @return AlterMirrorStatusResponseDataList

type ClusterV3Api

type ClusterV3Api interface {

	/*
	 * GetKafkaV3Cluster 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
	 */
	GetKafkaV3Cluster(ctx _context.Context, clusterId string) (ClusterData, *_nethttp.Response, error)
}

type ClusterV3ApiService

type ClusterV3ApiService service

ClusterV3ApiService ClusterV3Api service

func (*ClusterV3ApiService) GetKafkaV3Cluster

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

* GetKafkaV3Cluster 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 ConfigData

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

ConfigData struct for ConfigData

type ConfigSource

type ConfigSource string

ConfigSource the model 'ConfigSource'

const (
	CONFIGSOURCE_DYNAMIC_CLUSTER_LINK_CONFIG   ConfigSource = "DYNAMIC_CLUSTER_LINK_CONFIG"
	CONFIGSOURCE_DYNAMIC_TOPIC_CONFIG          ConfigSource = "DYNAMIC_TOPIC_CONFIG"
	CONFIGSOURCE_DYNAMIC_BROKER_LOGGER_CONFIG  ConfigSource = "DYNAMIC_BROKER_LOGGER_CONFIG"
	CONFIGSOURCE_DYNAMIC_BROKER_CONFIG         ConfigSource = "DYNAMIC_BROKER_CONFIG"
	CONFIGSOURCE_DYNAMIC_DEFAULT_BROKER_CONFIG ConfigSource = "DYNAMIC_DEFAULT_BROKER_CONFIG"
	CONFIGSOURCE_STATIC_BROKER_CONFIG          ConfigSource = "STATIC_BROKER_CONFIG"
	CONFIGSOURCE_DEFAULT_CONFIG                ConfigSource = "DEFAULT_CONFIG"
	CONFIGSOURCE_UNKNOWN                       ConfigSource = "UNKNOWN"
)

List of ConfigSource

type ConfigSynonymData

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

ConfigSynonymData struct for ConfigSynonymData

type ConfigsApi

type ConfigsApi interface {

	/*
	 * ListKafkaV3DefaultTopicConfigs 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
	 */
	ListKafkaV3DefaultTopicConfigs(ctx _context.Context, clusterId string, topicName string) (TopicConfigDataList, *_nethttp.Response, error)
}

type ConfigsApiService

type ConfigsApiService service

ConfigsApiService ConfigsApi service

func (*ConfigsApiService) ListKafkaV3DefaultTopicConfigs

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

* ListKafkaV3DefaultTopicConfigs 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

type ConfigsV3Api

type ConfigsV3Api interface {

	/*
	 * DeleteKafkaV3ClusterConfig 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.
	 */
	DeleteKafkaV3ClusterConfig(ctx _context.Context, clusterId string, name string) (*_nethttp.Response, error)

	/*
	 * DeleteKafkaV3TopicConfig 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.
	 */
	DeleteKafkaV3TopicConfig(ctx _context.Context, clusterId string, topicName string, name string) (*_nethttp.Response, error)

	/*
	 * GetKafkaV3ClusterConfig 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
	 */
	GetKafkaV3ClusterConfig(ctx _context.Context, clusterId string, name string) (ClusterConfigData, *_nethttp.Response, error)

	/*
	 * GetKafkaV3TopicConfig 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
	 */
	GetKafkaV3TopicConfig(ctx _context.Context, clusterId string, topicName string, name string) (TopicConfigData, *_nethttp.Response, error)

	/*
	 * ListKafkaV3AllTopicConfigs 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
	 */
	ListKafkaV3AllTopicConfigs(ctx _context.Context, clusterId string) (TopicConfigDataList, *_nethttp.Response, error)

	/*
	 * ListKafkaV3ClusterConfigs 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
	 */
	ListKafkaV3ClusterConfigs(ctx _context.Context, clusterId string) (ClusterConfigDataList, *_nethttp.Response, error)

	/*
	 * ListKafkaV3TopicConfigs 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
	 */
	ListKafkaV3TopicConfigs(ctx _context.Context, clusterId string, topicName string) (TopicConfigDataList, *_nethttp.Response, error)

	/*
	 * UpdateKafkaV3ClusterConfig 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 *UpdateKafkaV3ClusterConfigOpts - Optional Parameters:
	 * @param "UpdateConfigRequestData" (optional.Interface of UpdateConfigRequestData) -  The cluster configuration parameter update request.
	 */
	UpdateKafkaV3ClusterConfig(ctx _context.Context, clusterId string, name string, localVarOptionals *UpdateKafkaV3ClusterConfigOpts) (*_nethttp.Response, error)

	/*
	 * UpdateKafkaV3ClusterConfigs 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 *UpdateKafkaV3ClusterConfigsOpts - Optional Parameters:
	 * @param "AlterConfigBatchRequestData" (optional.Interface of AlterConfigBatchRequestData) -  The alter cluster configuration parameter batch request.
	 */
	UpdateKafkaV3ClusterConfigs(ctx _context.Context, clusterId string, localVarOptionals *UpdateKafkaV3ClusterConfigsOpts) (*_nethttp.Response, error)

	/*
	 * UpdateKafkaV3TopicConfig 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 *UpdateKafkaV3TopicConfigOpts - Optional Parameters:
	 * @param "UpdateConfigRequestData" (optional.Interface of UpdateConfigRequestData) -  The topic configuration parameter update request.
	 */
	UpdateKafkaV3TopicConfig(ctx _context.Context, clusterId string, topicName string, name string, localVarOptionals *UpdateKafkaV3TopicConfigOpts) (*_nethttp.Response, error)

	/*
	 * UpdateKafkaV3TopicConfigBatch 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 *UpdateKafkaV3TopicConfigBatchOpts - Optional Parameters:
	 * @param "AlterConfigBatchRequestData" (optional.Interface of AlterConfigBatchRequestData) -  The alter topic configuration parameter batch request.
	 */
	UpdateKafkaV3TopicConfigBatch(ctx _context.Context, clusterId string, topicName string, localVarOptionals *UpdateKafkaV3TopicConfigBatchOpts) (*_nethttp.Response, error)
}

type ConfigsV3ApiService

type ConfigsV3ApiService service

ConfigsV3ApiService ConfigsV3Api service

func (*ConfigsV3ApiService) DeleteKafkaV3ClusterConfig

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

* DeleteKafkaV3ClusterConfig 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) DeleteKafkaV3TopicConfig

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

* DeleteKafkaV3TopicConfig 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) GetKafkaV3ClusterConfig

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

* GetKafkaV3ClusterConfig 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) GetKafkaV3TopicConfig

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

* GetKafkaV3TopicConfig 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) ListKafkaV3AllTopicConfigs

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

* ListKafkaV3AllTopicConfigs 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) ListKafkaV3ClusterConfigs

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

* ListKafkaV3ClusterConfigs 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) ListKafkaV3TopicConfigs

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

* ListKafkaV3TopicConfigs 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) UpdateKafkaV3ClusterConfig

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

* UpdateKafkaV3ClusterConfig 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 *UpdateKafkaV3ClusterConfigOpts - Optional Parameters: * @param "UpdateConfigRequestData" (optional.Interface of UpdateConfigRequestData) - The cluster configuration parameter update request.

func (*ConfigsV3ApiService) UpdateKafkaV3ClusterConfigs

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

* UpdateKafkaV3ClusterConfigs 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 *UpdateKafkaV3ClusterConfigsOpts - Optional Parameters: * @param "AlterConfigBatchRequestData" (optional.Interface of AlterConfigBatchRequestData) - The alter cluster configuration parameter batch request.

func (*ConfigsV3ApiService) UpdateKafkaV3TopicConfig

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

* UpdateKafkaV3TopicConfig 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 *UpdateKafkaV3TopicConfigOpts - Optional Parameters: * @param "UpdateConfigRequestData" (optional.Interface of UpdateConfigRequestData) - The topic configuration parameter update request.

func (*ConfigsV3ApiService) UpdateKafkaV3TopicConfigBatch

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

* UpdateKafkaV3TopicConfigBatch 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 *UpdateKafkaV3TopicConfigBatchOpts - 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             ConsumerGroupState `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             ConsumerGroupState `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 ConsumerGroupState

type ConsumerGroupState string

ConsumerGroupState the model 'ConsumerGroupState'

const (
	CONSUMERGROUPSTATE_UNKNOWN              ConsumerGroupState = "UNKNOWN"
	CONSUMERGROUPSTATE_PREPARING_REBALANCE  ConsumerGroupState = "PREPARING_REBALANCE"
	CONSUMERGROUPSTATE_COMPLETING_REBALANCE ConsumerGroupState = "COMPLETING_REBALANCE"
	CONSUMERGROUPSTATE_STABLE               ConsumerGroupState = "STABLE"
	CONSUMERGROUPSTATE_DEAD                 ConsumerGroupState = "DEAD"
	CONSUMERGROUPSTATE_EMPTY                ConsumerGroupState = "EMPTY"
)

List of ConsumerGroupState

type ConsumerGroupV3Api

type ConsumerGroupV3Api interface {

	/*
	 * GetKafkaV3Consumer 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
	 */
	GetKafkaV3Consumer(ctx _context.Context, clusterId string, consumerGroupId string, consumerId string) (ConsumerData, *_nethttp.Response, error)

	/*
	 * GetKafkaV3ConsumerGroup 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
	 */
	GetKafkaV3ConsumerGroup(ctx _context.Context, clusterId string, consumerGroupId string) (ConsumerGroupData, *_nethttp.Response, error)

	/*
	 * GetKafkaV3ConsumerGroupLagSummary 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
	 */
	GetKafkaV3ConsumerGroupLagSummary(ctx _context.Context, clusterId string, consumerGroupId string) (ConsumerGroupLagSummaryData, *_nethttp.Response, error)

	/*
	 * ListKafkaV3ConsumerGroups 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
	 */
	ListKafkaV3ConsumerGroups(ctx _context.Context, clusterId string) (ConsumerGroupDataList, *_nethttp.Response, error)

	/*
	 * ListKafkaV3ConsumerLags 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
	 */
	ListKafkaV3ConsumerLags(ctx _context.Context, clusterId string, consumerGroupId string) (ConsumerLagDataList, *_nethttp.Response, error)

	/*
	 * ListKafkaV3Consumers 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
	 */
	ListKafkaV3Consumers(ctx _context.Context, clusterId string, consumerGroupId string) (ConsumerDataList, *_nethttp.Response, error)
}

type ConsumerGroupV3ApiService

type ConsumerGroupV3ApiService service

ConsumerGroupV3ApiService ConsumerGroupV3Api service

func (*ConsumerGroupV3ApiService) GetKafkaV3Consumer

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

* GetKafkaV3Consumer 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) GetKafkaV3ConsumerGroup

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

* GetKafkaV3ConsumerGroup 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) GetKafkaV3ConsumerGroupLagSummary

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

* GetKafkaV3ConsumerGroupLagSummary 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) ListKafkaV3ConsumerGroups

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

* ListKafkaV3ConsumerGroups 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) ListKafkaV3ConsumerLags

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

* ListKafkaV3ConsumerLags 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) ListKafkaV3Consumers

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

* ListKafkaV3Consumers 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  AclPatternType  `json:"pattern_type"`
	Principal    string          `json:"principal"`
	Host         string          `json:"host"`
	Operation    AclOperation    `json:"operation"`
	Permission   AclPermission   `json:"permission"`
}

CreateAclRequestData struct for CreateAclRequestData

type CreateKafkaV3AclsOpts

type CreateKafkaV3AclsOpts struct {
	CreateAclRequestData optional.Interface
}

CreateKafkaV3AclsOpts Optional parameters for the method 'CreateKafkaV3Acls'

type CreateKafkaV3LinkOpts

type CreateKafkaV3LinkOpts struct {
	CreateLinkRequestData optional.Interface
}

CreateKafkaV3LinkOpts Optional parameters for the method 'CreateKafkaV3Link'

type CreateKafkaV3MirrorTopicOpts

type CreateKafkaV3MirrorTopicOpts struct {
	CreateMirrorTopicRequestData optional.Interface
}

CreateKafkaV3MirrorTopicOpts Optional parameters for the method 'CreateKafkaV3MirrorTopic'

type CreateKafkaV3TopicOpts

type CreateKafkaV3TopicOpts struct {
	CreateTopicRequestData optional.Interface
}

CreateKafkaV3TopicOpts Optional parameters for the method 'CreateKafkaV3Topic'

type CreateLinkRequestData

type CreateLinkRequestData struct {
	SourceClusterId string       `json:"source_cluster_id"`
	Configs         []ConfigData `json:"configs,omitempty"`
}

CreateLinkRequestData struct for CreateLinkRequestData

type CreateMirrorTopicRequestData

type CreateMirrorTopicRequestData struct {
	SourceTopicName   string       `json:"source_topic_name"`
	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 DeleteKafkaV3AclsOpts

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

DeleteKafkaV3AclsOpts Optional parameters for the method 'DeleteKafkaV3Acls'

type DeprecatedBrokerShutdownStatus

type DeprecatedBrokerShutdownStatus string

DeprecatedBrokerShutdownStatus the model 'DeprecatedBrokerShutdownStatus'

const (
	DEPRECATEDBROKERSHUTDOWNSTATUS_FAILED   DeprecatedBrokerShutdownStatus = "FAILED"
	DEPRECATEDBROKERSHUTDOWNSTATUS_CANCELED DeprecatedBrokerShutdownStatus = "CANCELED"
	DEPRECATEDBROKERSHUTDOWNSTATUS_PENDING  DeprecatedBrokerShutdownStatus = "PENDING"
	DEPRECATEDBROKERSHUTDOWNSTATUS_COMPLETE DeprecatedBrokerShutdownStatus = "COMPLETE"
)

List of DeprecatedBrokerShutdownStatus

type DeprecatedPartitionReassignmentStatus

type DeprecatedPartitionReassignmentStatus string

DeprecatedPartitionReassignmentStatus the model 'DeprecatedPartitionReassignmentStatus'

const (
	DEPRECATEDPARTITIONREASSIGNMENTSTATUS_CANCELED    DeprecatedPartitionReassignmentStatus = "CANCELED"
	DEPRECATEDPARTITIONREASSIGNMENTSTATUS_FAILED      DeprecatedPartitionReassignmentStatus = "FAILED"
	DEPRECATEDPARTITIONREASSIGNMENTSTATUS_PENDING     DeprecatedPartitionReassignmentStatus = "PENDING"
	DEPRECATEDPARTITIONREASSIGNMENTSTATUS_IN_PROGRESS DeprecatedPartitionReassignmentStatus = "IN_PROGRESS"
	DEPRECATEDPARTITIONREASSIGNMENTSTATUS_COMPLETE    DeprecatedPartitionReassignmentStatus = "COMPLETE"
)

List of DeprecatedPartitionReassignmentStatus

type Error

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

Error struct for Error

type ExclusionOp

type ExclusionOp string

ExclusionOp the model 'ExclusionOp'

const (
	EXCLUSIONOP_SET     ExclusionOp = "SET"
	EXCLUSIONOP_DELETE  ExclusionOp = "DELETE"
	EXCLUSIONOP_UNKNOWN ExclusionOp = "UNKNOWN"
)

List of ExclusionOp

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 GetKafkaV3AclsOpts

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

GetKafkaV3AclsOpts Optional parameters for the method 'GetKafkaV3Acls'

type InlineResponse200

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

InlineResponse200 struct for InlineResponse200

type ListKafkaV3MirrorTopicsOpts

type ListKafkaV3MirrorTopicsOpts struct {
	MirrorStatus optional.Interface
}

ListKafkaV3MirrorTopicsOpts Optional parameters for the method 'ListKafkaV3MirrorTopics'

type ListKafkaV3MirrorTopicsUnderLinkOpts

type ListKafkaV3MirrorTopicsUnderLinkOpts struct {
	MirrorStatus optional.Interface
}

ListKafkaV3MirrorTopicsUnderLinkOpts Optional parameters for the method 'ListKafkaV3MirrorTopicsUnderLink'

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"`
	LinkName        string           `json:"link_name"`
	LinkId          string           `json:"link_id"`
	TopicsNames     []string         `json:"topics_names,omitempty"`
}

ListLinksResponseData struct for ListLinksResponseData

type ListLinksResponseDataAllOf

type ListLinksResponseDataAllOf struct {
	SourceClusterId string   `json:"source_cluster_id"`
	LinkName        string   `json:"link_name"`
	LinkId          string   `json:"link_id"`
	TopicsNames     []string `json:"topics_names,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        MirrorLags        `json:"mirror_lags"`
	MirrorTopicStatus MirrorTopicStatus `json:"mirror_topic_status"`
	StateTimeMs       int32             `json:"state_time_ms"`
}

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        MirrorLags        `json:"mirror_lags"`
	MirrorTopicStatus MirrorTopicStatus `json:"mirror_topic_status"`
	StateTimeMs       int32             `json:"state_time_ms"`
}

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                   int32 `json:"lag"`
	LastSourceFetchOffset int64 `json:"last_source_fetch_offset"`
}

MirrorLag struct for MirrorLag

type MirrorLags

type MirrorLags struct {
}

MirrorLags struct for MirrorLags

type MirrorTopicStatus

type MirrorTopicStatus string

MirrorTopicStatus the model 'MirrorTopicStatus'

const (
	MIRRORTOPICSTATUS_ACTIVE          MirrorTopicStatus = "active"
	MIRRORTOPICSTATUS_FAILED          MirrorTopicStatus = "failed"
	MIRRORTOPICSTATUS_PAUSED          MirrorTopicStatus = "paused"
	MIRRORTOPICSTATUS_STOPPED         MirrorTopicStatus = "stopped"
	MIRRORTOPICSTATUS_PENDING_STOPPED MirrorTopicStatus = "pending_stopped"
)

List of MirrorTopicStatus

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 PartitionReassignmentStatus

type PartitionReassignmentStatus string

PartitionReassignmentStatus the model 'PartitionReassignmentStatus'

const (
	PARTITIONREASSIGNMENTSTATUS_CANCELED    PartitionReassignmentStatus = "CANCELED"
	PARTITIONREASSIGNMENTSTATUS_ERROR       PartitionReassignmentStatus = "ERROR"
	PARTITIONREASSIGNMENTSTATUS_PENDING     PartitionReassignmentStatus = "PENDING"
	PARTITIONREASSIGNMENTSTATUS_IN_PROGRESS PartitionReassignmentStatus = "IN_PROGRESS"
	PARTITIONREASSIGNMENTSTATUS_COMPLETED   PartitionReassignmentStatus = "COMPLETED"
	PARTITIONREASSIGNMENTSTATUS_UNKNOWN     PartitionReassignmentStatus = "UNKNOWN"
)

List of PartitionReassignmentStatus

type PartitionV3Api

type PartitionV3Api interface {

	/*
	 * GetKafkaV3ConsumerLag 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
	 */
	GetKafkaV3ConsumerLag(ctx _context.Context, clusterId string, consumerGroupId string, topicName string, partitionId int32) (ConsumerLagData, *_nethttp.Response, error)

	/*
	 * GetKafkaV3Partition 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
	 */
	GetKafkaV3Partition(ctx _context.Context, clusterId string, topicName string, partitionId int32) (PartitionData, *_nethttp.Response, error)

	/*
	 * ListKafkaV3Partitions 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
	 */
	ListKafkaV3Partitions(ctx _context.Context, clusterId string, topicName string) (PartitionDataList, *_nethttp.Response, error)
}

type PartitionV3ApiService

type PartitionV3ApiService service

PartitionV3ApiService PartitionV3Api service

func (*PartitionV3ApiService) GetKafkaV3ConsumerLag

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

* GetKafkaV3ConsumerLag 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) GetKafkaV3Partition

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

* GetKafkaV3Partition 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) ListKafkaV3Partitions

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

* ListKafkaV3Partitions 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

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

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"`
	RawSchema           *string      `json:"raw_schema,omitempty"`
	Data                *interface{} `json:"data,omitempty"`
}

ProduceRequestData struct for ProduceRequestData

type ProduceRequestHeader

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

ProduceRequestHeader struct for ProduceRequestHeader

type ProduceResponse

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

type ProduceResponseData struct {
	Size          int32   `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 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 Relationship

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

Relationship struct for Relationship

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 BrokerReplicaExclusionStatus          `json:"broker_replica_exclusion_status"`
	PartitionReassignmentStatus  DeprecatedPartitionReassignmentStatus `json:"partition_reassignment_status"`
	BrokerShutdownStatus         DeprecatedBrokerShutdownStatus        `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 BrokerReplicaExclusionStatus          `json:"broker_replica_exclusion_status"`
	PartitionReassignmentStatus  DeprecatedPartitionReassignmentStatus `json:"partition_reassignment_status"`
	BrokerShutdownStatus         DeprecatedBrokerShutdownStatus        `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 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 ReplicaStatusData

type ReplicaStatusData struct {
	Kind               string           `json:"kind"`
	Metadata           ResourceMetadata `json:"metadata"`
	ClusterId          string           `json:"clusterId"`
	TopicName          string           `json:"topicName"`
	BrokerId           int32            `json:"brokerId"`
	PartitionId        int32            `json:"partitionId"`
	Leader             bool             `json:"leader"`
	Observer           bool             `json:"observer"`
	IsrEligible        bool             `json:"isrEligible"`
	InIsr              bool             `json:"inIsr"`
	CaughtUp           bool             `json:"caughtUp"`
	LogStartOffset     int32            `json:"logStartOffset"`
	LogEndOffset       int32            `json:"logEndOffset"`
	LastCaughtUpTimeMs int32            `json:"lastCaughtUpTimeMs"`
	LastFetchTimeMs    int32            `json:"lastFetchTimeMs"`
	LinkName           string           `json:"linkName,omitempty"`
}

ReplicaStatusData struct for ReplicaStatusData

type ReplicaStatusDataAllOf

type ReplicaStatusDataAllOf struct {
	ClusterId          string `json:"clusterId"`
	TopicName          string `json:"topicName"`
	BrokerId           int32  `json:"brokerId"`
	PartitionId        int32  `json:"partitionId"`
	Leader             bool   `json:"leader"`
	Observer           bool   `json:"observer"`
	IsrEligible        bool   `json:"isrEligible"`
	InIsr              bool   `json:"inIsr"`
	CaughtUp           bool   `json:"caughtUp"`
	LogStartOffset     int32  `json:"logStartOffset"`
	LogEndOffset       int32  `json:"logEndOffset"`
	LastCaughtUpTimeMs int32  `json:"lastCaughtUpTimeMs"`
	LastFetchTimeMs    int32  `json:"lastFetchTimeMs"`
	LinkName           string `json:"linkName,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 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      ConfigSource        `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

type TopicV3Api interface {

	/*
	 * CreateKafkaV3Topic 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 *CreateKafkaV3TopicOpts - Optional Parameters:
	 * @param "CreateTopicRequestData" (optional.Interface of CreateTopicRequestData) -  The topic creation request.
	 * @return TopicData
	 */
	CreateKafkaV3Topic(ctx _context.Context, clusterId string, localVarOptionals *CreateKafkaV3TopicOpts) (TopicData, *_nethttp.Response, error)

	/*
	 * DeleteKafkaV3Topic 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.
	 */
	DeleteKafkaV3Topic(ctx _context.Context, clusterId string, topicName string) (*_nethttp.Response, error)

	/*
	 * GetKafkaV3Topic 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
	 */
	GetKafkaV3Topic(ctx _context.Context, clusterId string, topicName string) (TopicData, *_nethttp.Response, error)

	/*
	 * ListKafkaV3Topics 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
	 */
	ListKafkaV3Topics(ctx _context.Context, clusterId string) (TopicDataList, *_nethttp.Response, error)
}

type TopicV3ApiService

type TopicV3ApiService service

TopicV3ApiService TopicV3Api service

func (*TopicV3ApiService) CreateKafkaV3Topic

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

* CreateKafkaV3Topic 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 *CreateKafkaV3TopicOpts - Optional Parameters: * @param "CreateTopicRequestData" (optional.Interface of CreateTopicRequestData) - The topic creation request. * @return TopicData

func (*TopicV3ApiService) DeleteKafkaV3Topic

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

* DeleteKafkaV3Topic 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) GetKafkaV3Topic

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

* GetKafkaV3Topic 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) ListKafkaV3Topics

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

* ListKafkaV3Topics 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 UpdateConfigRequestData

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

UpdateConfigRequestData struct for UpdateConfigRequestData

type UpdateKafkaV3ClusterConfigOpts

type UpdateKafkaV3ClusterConfigOpts struct {
	UpdateConfigRequestData optional.Interface
}

UpdateKafkaV3ClusterConfigOpts Optional parameters for the method 'UpdateKafkaV3ClusterConfig'

type UpdateKafkaV3ClusterConfigsOpts

type UpdateKafkaV3ClusterConfigsOpts struct {
	AlterConfigBatchRequestData optional.Interface
}

UpdateKafkaV3ClusterConfigsOpts Optional parameters for the method 'UpdateKafkaV3ClusterConfigs'

type UpdateKafkaV3LinkConfigBatchOpts

type UpdateKafkaV3LinkConfigBatchOpts struct {
	AlterConfigBatchRequestData optional.Interface
}

UpdateKafkaV3LinkConfigBatchOpts Optional parameters for the method 'UpdateKafkaV3LinkConfigBatch'

type UpdateKafkaV3LinkConfigOpts

type UpdateKafkaV3LinkConfigOpts struct {
	UpdateLinkConfigRequestData optional.Interface
}

UpdateKafkaV3LinkConfigOpts Optional parameters for the method 'UpdateKafkaV3LinkConfig'

type UpdateKafkaV3MirrorTopicsFailoverOpts

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

UpdateKafkaV3MirrorTopicsFailoverOpts Optional parameters for the method 'UpdateKafkaV3MirrorTopicsFailover'

type UpdateKafkaV3MirrorTopicsPauseOpts

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

UpdateKafkaV3MirrorTopicsPauseOpts Optional parameters for the method 'UpdateKafkaV3MirrorTopicsPause'

type UpdateKafkaV3MirrorTopicsPromoteOpts

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

UpdateKafkaV3MirrorTopicsPromoteOpts Optional parameters for the method 'UpdateKafkaV3MirrorTopicsPromote'

type UpdateKafkaV3MirrorTopicsResumeOpts

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

UpdateKafkaV3MirrorTopicsResumeOpts Optional parameters for the method 'UpdateKafkaV3MirrorTopicsResume'

type UpdateKafkaV3TopicConfigBatchOpts

type UpdateKafkaV3TopicConfigBatchOpts struct {
	AlterConfigBatchRequestData optional.Interface
}

UpdateKafkaV3TopicConfigBatchOpts Optional parameters for the method 'UpdateKafkaV3TopicConfigBatch'

type UpdateKafkaV3TopicConfigOpts

type UpdateKafkaV3TopicConfigOpts struct {
	UpdateConfigRequestData optional.Interface
}

UpdateKafkaV3TopicConfigOpts Optional parameters for the method 'UpdateKafkaV3TopicConfig'

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