# README
Go API client for kafkarestv3
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Overview
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 3.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://confluent.slack.com/app_redirect?channel=kafka-rest-eng
Installation
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional
Put the package under your project folder and add the following in import:
import "./kafkarestv3"
Documentation for API Endpoints
All URIs are relative to http://localhost:8082/v3
Class | Method | HTTP request | Description |
---|---|---|---|
ACLV3Api | CreateKafkaAcls | Post /clusters/{cluster_id}/acls | Create ACLs |
ACLV3Api | DeleteKafkaAcls | Delete /clusters/{cluster_id}/acls | Delete ACLs |
ACLV3Api | GetKafkaAcls | Get /clusters/{cluster_id}/acls | Search ACLs |
BalancerStatusV3Api | ClustersClusterIdBalancerAnyUnevenLoadGet | Get /clusters/{cluster_id}/balancer/any-uneven-load | Get AnyUnevenLoad status |
BalancerStatusV3Api | ClustersClusterIdBalancerGet | Get /clusters/{cluster_id}/balancer | Get status of the balancer |
BrokerApi | ClustersClusterIdBrokersdeletePost | Post /clusters/{cluster_id}/brokers:delete | Delete several brokers |
BrokerReplicaExclusionApi | ClustersClusterIdBrokerReplicaExclusionsBrokerIdGet | Get /clusters/{cluster_id}/broker-replica-exclusions/{broker_id} | Get a Broker Replica Exclusions. |
BrokerReplicaExclusionApi | ClustersClusterIdBrokerReplicaExclusionsGet | Get /clusters/{cluster_id}/broker-replica-exclusions | Get all Broker Replica Exclusions. |
BrokerReplicaExclusionApi | ClustersClusterIdBrokerReplicaExclusionscreatePost | Post /clusters/{cluster_id}/broker-replica-exclusions:create | Create Broker Replica Exclusions |
BrokerReplicaExclusionApi | ClustersClusterIdBrokerReplicaExclusionsdeletePost | Post /clusters/{cluster_id}/broker-replica-exclusions:delete | Delete Broker Replica Exclusions |
BrokerTaskApi | ClustersClusterIdBrokersBrokerIdTasksGet | Get /clusters/{cluster_id}/brokers/{broker_id}/tasks | List Broker Tasks of a specific Broker |
BrokerTaskApi | ClustersClusterIdBrokersBrokerIdTasksTaskTypeGet | Get /clusters/{cluster_id}/brokers/{broker_id}/tasks/{task_type} | Get single Broker Task. |
BrokerTaskApi | ClustersClusterIdBrokersTasksGet | Get /clusters/{cluster_id}/brokers/-/tasks | List Broker Tasks |
BrokerTaskApi | ClustersClusterIdBrokersTasksTaskTypeGet | Get /clusters/{cluster_id}/brokers/-/tasks/{task_type} | List Broker Tasks of a specific TaskType |
BrokerV3Api | ClustersClusterIdBrokersBrokerIdDelete | Delete /clusters/{cluster_id}/brokers/{broker_id} | Delete Broker |
BrokerV3Api | ClustersClusterIdBrokersBrokerIdGet | Get /clusters/{cluster_id}/brokers/{broker_id} | Get Broker |
BrokerV3Api | ClustersClusterIdBrokersBrokerIdPartitionReplicasGet | Get /clusters/{cluster_id}/brokers/{broker_id}/partition-replicas | Search Replicas by Broker |
BrokerV3Api | ClustersClusterIdBrokersGet | Get /clusters/{cluster_id}/brokers | List Brokers |
ClusterLinkingV3Api | CreateKafkaLink | Post /clusters/{cluster_id}/links | Create a cluster link |
ClusterLinkingV3Api | CreateKafkaMirrorTopic | Post /clusters/{cluster_id}/links/{link_name}/mirrors | Create a mirror topic |
ClusterLinkingV3Api | DeleteKafkaLink | Delete /clusters/{cluster_id}/links/{link_name} | Delete the cluster link |
ClusterLinkingV3Api | DeleteKafkaLinkConfig | Delete /clusters/{cluster_id}/links/{link_name}/configs/{config_name} | Reset the given config to default value |
ClusterLinkingV3Api | GetKafkaLink | Get /clusters/{cluster_id}/links/{link_name} | Describe the cluster link |
ClusterLinkingV3Api | GetKafkaLinkConfigs | Get /clusters/{cluster_id}/links/{link_name}/configs/{config_name} | Describe the config under the cluster link |
ClusterLinkingV3Api | ListKafkaLinkConfigs | Get /clusters/{cluster_id}/links/{link_name}/configs | List all configs of the cluster link |
ClusterLinkingV3Api | ListKafkaLinks | Get /clusters/{cluster_id}/links | List all cluster links in the dest cluster |
ClusterLinkingV3Api | ListKafkaMirrorTopics | Get /clusters/{cluster_id}/links/-/mirrors | List mirror topics |
ClusterLinkingV3Api | ListKafkaMirrorTopicsUnderLink | Get /clusters/{cluster_id}/links/{link_name}/mirrors | List mirror topics |
ClusterLinkingV3Api | ReadKafkaMirrorTopic | Get /clusters/{cluster_id}/links/{link_name}/mirrors/{mirror_topic_name} | Describe the mirror topic |
ClusterLinkingV3Api | UpdateKafkaLinkConfig | Put /clusters/{cluster_id}/links/{link_name}/configs/{config_name} | Alter the config under the cluster link |
ClusterLinkingV3Api | UpdateKafkaLinkConfigBatch | Put /clusters/{cluster_id}/links/{link_name}/configs:alter | Batch Alter Cluster Link Configs |
ClusterLinkingV3Api | UpdateKafkaMirrorTopicsFailover | Post /clusters/{cluster_id}/links/{link_name}/mirrors:failover | Failover the mirror topics |
ClusterLinkingV3Api | UpdateKafkaMirrorTopicsPause | Post /clusters/{cluster_id}/links/{link_name}/mirrors:pause | Pause the mirror topics |
ClusterLinkingV3Api | UpdateKafkaMirrorTopicsPromote | Post /clusters/{cluster_id}/links/{link_name}/mirrors:promote | Promote the mirror topics |
ClusterLinkingV3Api | UpdateKafkaMirrorTopicsPromoteLocalAndPauseRemoteMirror | Post /clusters/{cluster_id}/links/{link_name}/mirrors:promote-local-and-pause-remote-mirror | Promote the local mirror topic and Pause the remote mirror topic |
ClusterLinkingV3Api | UpdateKafkaMirrorTopicsPromoteLocalAndStartRemoteMirror | Post /clusters/{cluster_id}/links/{link_name}/mirrors:promote-local-and-start-remote-mirror | Promote the local mirror topic and start the remote mirror topic |
ClusterLinkingV3Api | UpdateKafkaMirrorTopicsResume | Post /clusters/{cluster_id}/links/{link_name}/mirrors:resume | Resume the mirror topics |
ClusterV3Api | ClustersGet | Get /clusters | List Clusters |
ClusterV3Api | GetKafkaCluster | Get /clusters/{cluster_id} | Get Cluster |
ConfigsV3Api | ClustersClusterIdBrokersBrokerIdConfigsGet | Get /clusters/{cluster_id}/brokers/{broker_id}/configs | List Broker Configs |
ConfigsV3Api | ClustersClusterIdBrokersBrokerIdConfigsNameDelete | Delete /clusters/{cluster_id}/brokers/{broker_id}/configs/{name} | Reset Broker Config |
ConfigsV3Api | ClustersClusterIdBrokersBrokerIdConfigsNameGet | Get /clusters/{cluster_id}/brokers/{broker_id}/configs/{name} | Get Broker Config |
ConfigsV3Api | ClustersClusterIdBrokersBrokerIdConfigsNamePut | Put /clusters/{cluster_id}/brokers/{broker_id}/configs/{name} | Update Broker Config |
ConfigsV3Api | ClustersClusterIdBrokersBrokerIdConfigsalterPost | Post /clusters/{cluster_id}/brokers/{broker_id}/configs:alter | Batch Alter Broker Configs |
ConfigsV3Api | ClustersClusterIdBrokersConfigsGet | Get /clusters/{cluster_id}/brokers/-/configs | List All Broker Configs |
ConfigsV3Api | DeleteKafkaClusterConfig | Delete /clusters/{cluster_id}/broker-configs/{name} | Reset Cluster Config |
ConfigsV3Api | DeleteKafkaTopicConfig | Delete /clusters/{cluster_id}/topics/{topic_name}/configs/{name} | Reset Topic Config |
ConfigsV3Api | GetKafkaClusterConfig | Get /clusters/{cluster_id}/broker-configs/{name} | Get Cluster Config |
ConfigsV3Api | GetKafkaTopicConfig | Get /clusters/{cluster_id}/topics/{topic_name}/configs/{name} | Get Topic Config |
ConfigsV3Api | ListKafkaAllTopicConfigs | Get /clusters/{cluster_id}/topics/-/configs | Get All Topic Configs |
ConfigsV3Api | ListKafkaClusterConfigs | Get /clusters/{cluster_id}/broker-configs | List Cluster Configs |
ConfigsV3Api | ListKafkaDefaultTopicConfigs | Get /clusters/{cluster_id}/topics/{topic_name}/default-configs | List Default Topic Configs |
ConfigsV3Api | ListKafkaTopicConfigs | Get /clusters/{cluster_id}/topics/{topic_name}/configs | List Topic Configs |
ConfigsV3Api | UpdateKafkaClusterConfig | Put /clusters/{cluster_id}/broker-configs/{name} | Update Cluster Config |
ConfigsV3Api | UpdateKafkaClusterConfigs | Post /clusters/{cluster_id}/broker-configs:alter | Batch Alter Cluster Configs |
ConfigsV3Api | UpdateKafkaTopicConfig | Put /clusters/{cluster_id}/topics/{topic_name}/configs/{name} | Update Topic Config |
ConfigsV3Api | UpdateKafkaTopicConfigBatch | Post /clusters/{cluster_id}/topics/{topic_name}/configs:alter | Batch Alter Topic Configs |
ConsumerGroupV3Api | GetKafkaConsumer | Get /clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id} | Get Consumer |
ConsumerGroupV3Api | GetKafkaConsumerAssignment | Get /clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id}/assignments/{topic_name}/partitions/{partition_id} | Get Consumer Assignment |
ConsumerGroupV3Api | GetKafkaConsumerGroup | Get /clusters/{cluster_id}/consumer-groups/{consumer_group_id} | Get Consumer Group |
ConsumerGroupV3Api | GetKafkaConsumerGroupLagSummary | Get /clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary | Get Consumer Group Lag Summary. |
ConsumerGroupV3Api | ListKafkaConsumerAssignment | Get /clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id}/assignments | List Consumer Assignments |
ConsumerGroupV3Api | ListKafkaConsumerGroups | Get /clusters/{cluster_id}/consumer-groups | List Consumer Groups |
ConsumerGroupV3Api | ListKafkaConsumerLags | Get /clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags | List Consumer Lags |
ConsumerGroupV3Api | ListKafkaConsumers | Get /clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers | List Consumers |
PartitionApi | ClustersClusterIdTopicsPartitionsReassignmentGet | Get /clusters/{cluster_id}/topics/-/partitions/-/reassignment | List All Replica Reassignments |
PartitionApi | ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReassignmentGet | Get /clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}/reassignment | Get Replica Reassignments |
PartitionApi | ClustersClusterIdTopicsTopicNamePartitionsReassignmentGet | Get /clusters/{cluster_id}/topics/{topic_name}/partitions/-/reassignment | Search Replica Reassignments By Topic |
PartitionV3Api | GetKafkaConsumerLag | Get /clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags/{topic_name}/partitions/{partition_id} | Get Consumer Lag |
PartitionV3Api | GetKafkaPartition | Get /clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id} | Get Partition |
PartitionV3Api | ListKafkaPartitions | Get /clusters/{cluster_id}/topics/{topic_name}/partitions | List Partitions |
RecordsV3Api | ClustersClusterIdTopicsTopicNameRecordsPost | Post /clusters/{cluster_id}/topics/{topic_name}/records | Produce records to the given topic. |
RemoveBrokerTaskApi | ClustersClusterIdRemoveBrokerTasksBrokerIdGet | Get /clusters/{cluster_id}/remove-broker-tasks/{broker_id} | Get Remove Broker Task |
RemoveBrokerTaskApi | ClustersClusterIdRemoveBrokerTasksGet | Get /clusters/{cluster_id}/remove-broker-tasks | List Remove Broker Tasks |
ReplicaApi | ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicasBrokerIdGet | Get /clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}/replicas/{broker_id} | Get Replica |
ReplicaApi | ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicasGet | Get /clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}/replicas | List Replicas |
ReplicaStatusApi | ClustersClusterIdTopicsPartitionsReplicaStatusGet | Get /clusters/{cluster_id}/topics/-/partitions/-/replica-status | List All Replica Statuses from a cluster. |
ReplicaStatusApi | ClustersClusterIdTopicsTopicNamePartitionsPartitionIdReplicaStatusGet | Get /clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}/replica-status | List Partition Replica Statuses. |
ReplicaStatusApi | ClustersClusterIdTopicsTopicNamePartitionsReplicaStatusGet | Get /clusters/{cluster_id}/topics/{topic_name}/partitions/-/replica-status | List All Partition Replica Statuses. |
ReplicaV3Api | ClustersClusterIdBrokersBrokerIdPartitionReplicasGet | Get /clusters/{cluster_id}/brokers/{broker_id}/partition-replicas | Search Replicas by Broker |
TopicV3Api | CreateKafkaTopic | Post /clusters/{cluster_id}/topics | Create Topic |
TopicV3Api | DeleteKafkaTopic | Delete /clusters/{cluster_id}/topics/{topic_name} | Delete Topic |
TopicV3Api | GetKafkaTopic | Get /clusters/{cluster_id}/topics/{topic_name} | Get Topic |
TopicV3Api | ListKafkaTopics | Get /clusters/{cluster_id}/topics | List Topics |
UnregisterV3Api | ClustersClusterIdBrokersBrokerIdunregisterPost | Post /clusters/{cluster_id}/brokers/{broker_id}:unregister | Unregister a Broker |
Documentation For Models
- AbstractConfigData
- AbstractConfigDataAllOf
- AclData
- AclDataAllOf
- AclDataList
- AclResourceType
- AlterBrokerReplicaExclusionData
- AlterBrokerReplicaExclusionDataAllOf
- AlterBrokerReplicaExclusionDataList
- AlterBrokerReplicaExclusionDataListAllOf
- AlterConfigBatchRequestData
- AlterConfigBatchRequestDataData
- AlterMirrorStatusResponseData
- AlterMirrorStatusResponseDataAllOf
- AlterMirrorStatusResponseDataList
- AlterMirrorStatusResponseDataListAllOf
- AlterMirrorsRequestData
- AnyUnevenLoadData
- AnyUnevenLoadDataAllOf
- BalancerStatusData
- BalancerStatusDataAllOf
- BrokerConfigData
- BrokerConfigDataAllOf
- BrokerConfigDataList
- BrokerConfigDataListAllOf
- BrokerData
- BrokerDataAllOf
- BrokerDataList
- BrokerDataListAllOf
- BrokerRemovalData
- BrokerRemovalDataAllOf
- BrokerRemovalDataList
- BrokerRemovalDataListAllOf
- BrokerReplicaExclusionBatchRequestData
- BrokerReplicaExclusionData
- BrokerReplicaExclusionDataAllOf
- BrokerReplicaExclusionDataList
- BrokerReplicaExclusionDataListAllOf
- BrokerReplicaExclusionRequestData
- BrokerTaskData
- BrokerTaskDataAllOf
- BrokerTaskDataList
- BrokerTaskDataListAllOf
- BrokerTaskType
- ClusterConfigData
- ClusterConfigDataAllOf
- ClusterConfigDataList
- ClusterConfigDataListAllOf
- ClusterData
- ClusterDataAllOf
- ClusterDataList
- ClusterDataListAllOf
- ConfigData
- ConfigSynonymData
- ConsumerAssignmentData
- ConsumerAssignmentDataAllOf
- ConsumerAssignmentDataList
- ConsumerAssignmentDataListAllOf
- ConsumerData
- ConsumerDataAllOf
- ConsumerDataList
- ConsumerDataListAllOf
- ConsumerGroupData
- ConsumerGroupDataAllOf
- ConsumerGroupDataList
- ConsumerGroupDataListAllOf
- ConsumerGroupLagSummaryData
- ConsumerGroupLagSummaryDataAllOf
- ConsumerLagData
- ConsumerLagDataAllOf
- ConsumerLagDataList
- ConsumerLagDataListAllOf
- CreateAclRequestData
- CreateLinkRequestData
- CreateMirrorTopicRequestData
- CreateTopicRequestData
- CreateTopicRequestDataConfigs
- CreateTopicRequestDataReplicasAssignments
- Error
- InlineResponse200
- ListLinkConfigsResponseData
- ListLinkConfigsResponseDataAllOf
- ListLinkConfigsResponseDataList
- ListLinkConfigsResponseDataListAllOf
- ListLinksResponseData
- ListLinksResponseDataAllOf
- ListLinksResponseDataList
- ListLinksResponseDataListAllOf
- ListMirrorTopicsResponseData
- ListMirrorTopicsResponseDataAllOf
- ListMirrorTopicsResponseDataList
- ListMirrorTopicsResponseDataListAllOf
- MirrorLag
- MirrorTopicStatus
- PartitionData
- PartitionDataAllOf
- PartitionDataList
- PartitionDataListAllOf
- ProduceRequest
- ProduceRequestData
- ProduceRequestHeader
- ProduceResponse
- ProduceResponseData
- ReassignmentData
- ReassignmentDataAllOf
- ReassignmentDataList
- ReassignmentDataListAllOf
- Relationship
- RemoveBrokerTaskData
- RemoveBrokerTaskDataAllOf
- RemoveBrokerTaskDataList
- RemoveBrokerTaskDataListAllOf
- RemoveBrokersRequestData
- ReplicaData
- ReplicaDataAllOf
- ReplicaDataList
- ReplicaDataListAllOf
- ReplicaStatusData
- ReplicaStatusDataAllOf
- ReplicaStatusDataList
- ReplicaStatusDataListAllOf
- Resource
- ResourceCollection
- ResourceCollectionMetadata
- ResourceMetadata
- TopicConfigData
- TopicConfigDataAllOf
- TopicConfigDataList
- TopicConfigDataListAllOf
- TopicData
- TopicDataAllOf
- TopicDataList
- TopicDataListAllOf
- TopicList
- UnregisterBrokerData
- UpdateConfigRequestData
- UpdateLinkConfigRequestData
Documentation For Authorization
Endpoints do not require authorization.