# pulsar-admin-go **Repository Path**: douchunrong/pulsar-admin-go ## Basic Information - **Project Name**: pulsar-admin-go - **Description**: pulsar admin restapi - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2021-09-18 - **Last Updated**: 2021-09-18 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Pulsar API client generated from the OpenAPI definition This provides the REST API for admin operations ## Overview This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. - API version: v2 - Package version: 1.0.0 - Build package: org.openapitools.codegen.languages.GoClientCodegen ## Installation Install the following dependencies: ```shell 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: ```golang import "./openapi" ``` ## Documentation for API Endpoints All URIs are relative to *http://localhost/admin/v2* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *BookiesApi* | [**DeleteBookieRackInfo**](docs/BookiesApi.md#deletebookierackinfo) | **Delete** /bookies/racks-info/{bookie} | Removed the rack placement information for a specific bookie in the cluster *BookiesApi* | [**GetBookieRackInfo**](docs/BookiesApi.md#getbookierackinfo) | **Get** /bookies/racks-info/{bookie} | Gets the rack placement information for a specific bookie in the cluster *BookiesApi* | [**GetBookiesRackInfo**](docs/BookiesApi.md#getbookiesrackinfo) | **Get** /bookies/racks-info | Gets the rack placement information for all the bookies in the cluster *BookiesApi* | [**UpdateBookieRackInfo**](docs/BookiesApi.md#updatebookierackinfo) | **Post** /bookies/racks-info/{bookie} | Updates the rack placement information for a specific bookie in the cluster *BrokerStatsApi* | [**GetAllocatorStats**](docs/BrokerStatsApi.md#getallocatorstats) | **Get** /broker-stats/allocator-stats/{allocator} | Get the stats for the Netty allocator. Available allocators are 'default' and 'ml-cache' *BrokerStatsApi* | [**GetBrokerResourceAvailability**](docs/BrokerStatsApi.md#getbrokerresourceavailability) | **Get** /broker-stats/broker-resource-availability/{tenant}/{namespace} | Broker availability report *BrokerStatsApi* | [**GetLoadReport**](docs/BrokerStatsApi.md#getloadreport) | **Get** /broker-stats/load-report | Get Load for this broker *BrokerStatsApi* | [**GetMBeans**](docs/BrokerStatsApi.md#getmbeans) | **Get** /broker-stats/mbeans | Get all the mbean details of this broker JVM *BrokerStatsApi* | [**GetMetrics**](docs/BrokerStatsApi.md#getmetrics) | **Get** /broker-stats/metrics | Gets the metrics for Monitoring *BrokerStatsApi* | [**GetPendingBookieOpsStats**](docs/BrokerStatsApi.md#getpendingbookieopsstats) | **Get** /broker-stats/bookieops | Get pending bookie client op stats by namesapce *BrokerStatsApi* | [**GetTopics2**](docs/BrokerStatsApi.md#gettopics2) | **Get** /broker-stats/topics | Get all the topic stats by namespace *BrokersApi* | [**GetActiveBrokers**](docs/BrokersApi.md#getactivebrokers) | **Get** /brokers/{cluster} | Get the list of active brokers (web service addresses) in the cluster.If authorization is not enabled, any cluster name is valid. *BrokersApi* | [**GetAllDynamicConfigurations**](docs/BrokersApi.md#getalldynamicconfigurations) | **Get** /brokers/configuration/values | Get value of all dynamic configurations' value overridden on local config *BrokersApi* | [**GetDynamicConfigurationName**](docs/BrokersApi.md#getdynamicconfigurationname) | **Get** /brokers/configuration | Get all updatable dynamic configurations's name *BrokersApi* | [**GetInternalConfigurationData**](docs/BrokersApi.md#getinternalconfigurationdata) | **Get** /brokers/internal-configuration | Get the internal configuration data *BrokersApi* | [**GetOwnedNamespaes**](docs/BrokersApi.md#getownednamespaes) | **Get** /brokers/{clusterName}/{broker-webserviceurl}/ownedNamespaces | Get the list of namespaces served by the specific broker *BrokersApi* | [**GetRuntimeConfiguration**](docs/BrokersApi.md#getruntimeconfiguration) | **Get** /brokers/configuration/runtime | Get all runtime configurations. This operation requires Pulsar super-user privileges. *BrokersApi* | [**Healthcheck**](docs/BrokersApi.md#healthcheck) | **Get** /brokers/health | Run a healthcheck against the broker *BrokersApi* | [**UpdateDynamicConfiguration**](docs/BrokersApi.md#updatedynamicconfiguration) | **Post** /brokers/configuration/{configName}/{configValue} | Update dynamic serviceconfiguration into zk only. This operation requires Pulsar super-user privileges. *ClustersApi* | [**CreateCluster**](docs/ClustersApi.md#createcluster) | **Put** /clusters/{cluster} | Create a new cluster. *ClustersApi* | [**DeleteCluster**](docs/ClustersApi.md#deletecluster) | **Delete** /clusters/{cluster} | Delete an existing cluster. *ClustersApi* | [**DeleteFailureDomain**](docs/ClustersApi.md#deletefailuredomain) | **Delete** /clusters/{cluster}/failureDomains/{domainName} | Delete the failure domain of the cluster *ClustersApi* | [**DeleteNamespaceIsolationPolicy**](docs/ClustersApi.md#deletenamespaceisolationpolicy) | **Delete** /clusters/{cluster}/namespaceIsolationPolicies/{policyName} | Delete namespace isolation policy. *ClustersApi* | [**GetBrokerWithNamespaceIsolationPolicy**](docs/ClustersApi.md#getbrokerwithnamespaceisolationpolicy) | **Get** /clusters/{cluster}/namespaceIsolationPolicies/brokers/{broker} | Get a broker with namespace-isolation policies attached to it. *ClustersApi* | [**GetBrokersWithNamespaceIsolationPolicy**](docs/ClustersApi.md#getbrokerswithnamespaceisolationpolicy) | **Get** /clusters/{cluster}/namespaceIsolationPolicies/brokers | Get list of brokers with namespace-isolation policies attached to them. *ClustersApi* | [**GetCluster**](docs/ClustersApi.md#getcluster) | **Get** /clusters/{cluster} | Get the configuration for the specified cluster. *ClustersApi* | [**GetClusters**](docs/ClustersApi.md#getclusters) | **Get** /clusters | Get the list of all the Pulsar clusters. *ClustersApi* | [**GetDomain**](docs/ClustersApi.md#getdomain) | **Get** /clusters/{cluster}/failureDomains/{domainName} | Get a domain in a cluster *ClustersApi* | [**GetFailureDomains**](docs/ClustersApi.md#getfailuredomains) | **Get** /clusters/{cluster}/failureDomains | Get the cluster failure domains. *ClustersApi* | [**GetNamespaceIsolationPolicies**](docs/ClustersApi.md#getnamespaceisolationpolicies) | **Get** /clusters/{cluster}/namespaceIsolationPolicies | Get the namespace isolation policies assigned to the cluster. *ClustersApi* | [**GetNamespaceIsolationPolicy**](docs/ClustersApi.md#getnamespaceisolationpolicy) | **Get** /clusters/{cluster}/namespaceIsolationPolicies/{policyName} | Get the single namespace isolation policy assigned to the cluster. *ClustersApi* | [**GetPeerCluster**](docs/ClustersApi.md#getpeercluster) | **Get** /clusters/{cluster}/peers | Get the peer-cluster data for the specified cluster. *ClustersApi* | [**SetFailureDomain**](docs/ClustersApi.md#setfailuredomain) | **Post** /clusters/{cluster}/failureDomains/{domainName} | Set the failure domain of the cluster. *ClustersApi* | [**SetNamespaceIsolationPolicy**](docs/ClustersApi.md#setnamespaceisolationpolicy) | **Post** /clusters/{cluster}/namespaceIsolationPolicies/{policyName} | Set namespace isolation policy. *ClustersApi* | [**SetPeerClusterNames**](docs/ClustersApi.md#setpeerclusternames) | **Post** /clusters/{cluster}/peers | Update peer-cluster-list for a cluster. *ClustersApi* | [**UpdateCluster**](docs/ClustersApi.md#updatecluster) | **Post** /clusters/{cluster} | Update the configuration for a cluster. *NamespacesApi* | [**ClearNamespaceBacklog**](docs/NamespacesApi.md#clearnamespacebacklog) | **Post** /namespaces/{tenant}/{namespace}/clearBacklog | Clear backlog for all topics on a namespace. *NamespacesApi* | [**ClearNamespaceBacklogForSubscription**](docs/NamespacesApi.md#clearnamespacebacklogforsubscription) | **Post** /namespaces/{tenant}/{namespace}/clearBacklog/{subscription} | Clear backlog for a given subscription on all topics on a namespace. *NamespacesApi* | [**ClearNamespaceBundleBacklog**](docs/NamespacesApi.md#clearnamespacebundlebacklog) | **Post** /namespaces/{tenant}/{namespace}/{bundle}/clearBacklog | Clear backlog for all topics on a namespace bundle. *NamespacesApi* | [**ClearNamespaceBundleBacklogForSubscription**](docs/NamespacesApi.md#clearnamespacebundlebacklogforsubscription) | **Post** /namespaces/{tenant}/{namespace}/{bundle}/clearBacklog/{subscription} | Clear backlog for a given subscription on all topics on a namespace bundle. *NamespacesApi* | [**ClearOffloadDeletionLag**](docs/NamespacesApi.md#clearoffloaddeletionlag) | **Delete** /namespaces/{tenant}/{namespace}/offloadDeletionLagMs | Clear the namespace configured offload deletion lag. The topics in the namespace will fallback to using the default configured deletion lag for the broker *NamespacesApi* | [**CreateNamespace**](docs/NamespacesApi.md#createnamespace) | **Put** /namespaces/{tenant}/{namespace} | Creates a new namespace with the specified policies *NamespacesApi* | [**DeleteBookieAffinityGroup**](docs/NamespacesApi.md#deletebookieaffinitygroup) | **Delete** /namespaces/{property}/{namespace}/persistence/bookieAffinity | Delete the bookie-affinity-group from namespace-local policy. *NamespacesApi* | [**DeleteNamespace**](docs/NamespacesApi.md#deletenamespace) | **Delete** /namespaces/{tenant}/{namespace} | Delete a namespace and all the topics under it. *NamespacesApi* | [**DeleteNamespaceBundle**](docs/NamespacesApi.md#deletenamespacebundle) | **Delete** /namespaces/{tenant}/{namespace}/{bundle} | Delete a namespace bundle and all the topics under it. *NamespacesApi* | [**GetAntiAffinityNamespaces**](docs/NamespacesApi.md#getantiaffinitynamespaces) | **Get** /namespaces/{cluster}/antiAffinity/{group} | Get all namespaces that are grouped by given anti-affinity group in a given cluster. api can be only accessed by admin of any of the existing tenant *NamespacesApi* | [**GetBacklogQuotaMap**](docs/NamespacesApi.md#getbacklogquotamap) | **Get** /namespaces/{tenant}/{namespace}/backlogQuotaMap | Get backlog quota map on a namespace. *NamespacesApi* | [**GetBookieAffinityGroup**](docs/NamespacesApi.md#getbookieaffinitygroup) | **Get** /namespaces/{property}/{namespace}/persistence/bookieAffinity | Get the bookie-affinity-group from namespace-local policy. *NamespacesApi* | [**GetBundlesData**](docs/NamespacesApi.md#getbundlesdata) | **Get** /namespaces/{tenant}/{namespace}/bundles | Get the bundles split data. *NamespacesApi* | [**GetCompactionThreshold**](docs/NamespacesApi.md#getcompactionthreshold) | **Get** /namespaces/{tenant}/{namespace}/compactionThreshold | Maximum number of uncompacted bytes in topics before compaction is triggered. *NamespacesApi* | [**GetDispatchRate**](docs/NamespacesApi.md#getdispatchrate) | **Get** /namespaces/{tenant}/{namespace}/dispatchRate | Get dispatch-rate configured for the namespace, -1 represents not configured yet *NamespacesApi* | [**GetMaxConsumersPerSubscription**](docs/NamespacesApi.md#getmaxconsumerspersubscription) | **Get** /namespaces/{tenant}/{namespace}/maxConsumersPerSubscription | Get maxConsumersPerSubscription config on a namespace. *NamespacesApi* | [**GetMaxConsumersPerTopic**](docs/NamespacesApi.md#getmaxconsumerspertopic) | **Get** /namespaces/{tenant}/{namespace}/maxConsumersPerTopic | Get maxConsumersPerTopic config on a namespace. *NamespacesApi* | [**GetMaxProducersPerTopic**](docs/NamespacesApi.md#getmaxproducerspertopic) | **Get** /namespaces/{tenant}/{namespace}/maxProducersPerTopic | Get maxProducersPerTopic config on a namespace. *NamespacesApi* | [**GetNamespaceAntiAffinityGroup**](docs/NamespacesApi.md#getnamespaceantiaffinitygroup) | **Get** /namespaces/{tenant}/{namespace}/antiAffinity | Get anti-affinity group of a namespace. *NamespacesApi* | [**GetNamespaceMessageTTL**](docs/NamespacesApi.md#getnamespacemessagettl) | **Get** /namespaces/{tenant}/{namespace}/messageTTL | Get the message TTL for the namespace *NamespacesApi* | [**GetNamespaceReplicationClusters**](docs/NamespacesApi.md#getnamespacereplicationclusters) | **Get** /namespaces/{tenant}/{namespace}/replication | Get the replication clusters for a namespace. *NamespacesApi* | [**GetOffloadDeletionLag**](docs/NamespacesApi.md#getoffloaddeletionlag) | **Get** /namespaces/{tenant}/{namespace}/offloadDeletionLagMs | Number of milliseconds to wait before deleting a ledger segment which has been offloaded from the Pulsar cluster's local storage (i.e. BookKeeper) *NamespacesApi* | [**GetOffloadThreshold**](docs/NamespacesApi.md#getoffloadthreshold) | **Get** /namespaces/{tenant}/{namespace}/offloadThreshold | Maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage *NamespacesApi* | [**GetPermissions**](docs/NamespacesApi.md#getpermissions) | **Get** /namespaces/{tenant}/{namespace}/permissions | Retrieve the permissions for a namespace. *NamespacesApi* | [**GetPersistence**](docs/NamespacesApi.md#getpersistence) | **Get** /namespaces/{tenant}/{namespace}/persistence | Get the persistence configuration for a namespace. *NamespacesApi* | [**GetPolicies**](docs/NamespacesApi.md#getpolicies) | **Get** /namespaces/{tenant}/{namespace} | Get the dump all the policies specified for a namespace. *NamespacesApi* | [**GetReplicatorDispatchRate**](docs/NamespacesApi.md#getreplicatordispatchrate) | **Get** /namespaces/{tenant}/{namespace}/replicatorDispatchRate | Get replicator dispatch-rate configured for the namespace, -1 represents not configured yet *NamespacesApi* | [**GetRetention**](docs/NamespacesApi.md#getretention) | **Get** /namespaces/{tenant}/{namespace}/retention | Get retention config on a namespace. *NamespacesApi* | [**GetSchemaAutoUpdateCompatibilityStrategy**](docs/NamespacesApi.md#getschemaautoupdatecompatibilitystrategy) | **Get** /namespaces/{tenant}/{namespace}/schemaAutoUpdateCompatibilityStrategy | The strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema *NamespacesApi* | [**GetSchemaValidtionEnforced**](docs/NamespacesApi.md#getschemavalidtionenforced) | **Get** /namespaces/{tenant}/{namespace}/schemaValidationEnforced | Get schema validation enforced flag for namespace. *NamespacesApi* | [**GetSubscribeRate**](docs/NamespacesApi.md#getsubscriberate) | **Get** /namespaces/{tenant}/{namespace}/subscribeRate | Get subscribe-rate configured for the namespace *NamespacesApi* | [**GetSubscriptionDispatchRate**](docs/NamespacesApi.md#getsubscriptiondispatchrate) | **Get** /namespaces/{tenant}/{namespace}/subscriptionDispatchRate | Get Subscription dispatch-rate configured for the namespace, -1 represents not configured yet *NamespacesApi* | [**GetTenantNamespaces**](docs/NamespacesApi.md#gettenantnamespaces) | **Get** /namespaces/{tenant} | Get the list of all the namespaces for a certain tenant. *NamespacesApi* | [**GetTopics**](docs/NamespacesApi.md#gettopics) | **Get** /namespaces/{tenant}/{namespace}/topics | Get the list of all the topics under a certain namespace. *NamespacesApi* | [**GrantPermissionOnNamespace**](docs/NamespacesApi.md#grantpermissiononnamespace) | **Post** /namespaces/{tenant}/{namespace}/permissions/{role} | Grant a new permission to a role on a namespace. *NamespacesApi* | [**ModifyDeduplication**](docs/NamespacesApi.md#modifydeduplication) | **Post** /namespaces/{tenant}/{namespace}/deduplication | Enable or disable broker side deduplication for all topics in a namespace *NamespacesApi* | [**ModifyEncryptionRequired**](docs/NamespacesApi.md#modifyencryptionrequired) | **Post** /namespaces/{tenant}/{namespace}/encryptionRequired | Message encryption is required or not for all topics in a namespace *NamespacesApi* | [**RemoveBacklogQuota**](docs/NamespacesApi.md#removebacklogquota) | **Delete** /namespaces/{tenant}/{namespace}/backlogQuota | Remove a backlog quota policy from a namespace. *NamespacesApi* | [**RemoveNamespaceAntiAffinityGroup**](docs/NamespacesApi.md#removenamespaceantiaffinitygroup) | **Delete** /namespaces/{tenant}/{namespace}/antiAffinity | Remove anti-affinity group of a namespace. *NamespacesApi* | [**RevokePermissionsOnNamespace**](docs/NamespacesApi.md#revokepermissionsonnamespace) | **Delete** /namespaces/{tenant}/{namespace}/permissions/{role} | Revoke all permissions to a role on a namespace. *NamespacesApi* | [**SetBacklogQuota**](docs/NamespacesApi.md#setbacklogquota) | **Post** /namespaces/{tenant}/{namespace}/backlogQuota | Set a backlog quota for all the topics on a namespace. *NamespacesApi* | [**SetBookieAffinityGroup**](docs/NamespacesApi.md#setbookieaffinitygroup) | **Post** /namespaces/{tenant}/{namespace}/persistence/bookieAffinity | Set the bookie-affinity-group to namespace-persistent policy. *NamespacesApi* | [**SetCompactionThreshold**](docs/NamespacesApi.md#setcompactionthreshold) | **Put** /namespaces/{tenant}/{namespace}/compactionThreshold | Set maximum number of uncompacted bytes in a topic before compaction is triggered. *NamespacesApi* | [**SetDispatchRate**](docs/NamespacesApi.md#setdispatchrate) | **Post** /namespaces/{tenant}/{namespace}/dispatchRate | Set dispatch-rate throttling for all topics of the namespace *NamespacesApi* | [**SetMaxConsumersPerSubscription**](docs/NamespacesApi.md#setmaxconsumerspersubscription) | **Post** /namespaces/{tenant}/{namespace}/maxConsumersPerSubscription | Set maxConsumersPerSubscription configuration on a namespace. *NamespacesApi* | [**SetMaxConsumersPerTopic**](docs/NamespacesApi.md#setmaxconsumerspertopic) | **Post** /namespaces/{tenant}/{namespace}/maxConsumersPerTopic | Set maxConsumersPerTopic configuration on a namespace. *NamespacesApi* | [**SetMaxProducersPerTopic**](docs/NamespacesApi.md#setmaxproducerspertopic) | **Post** /namespaces/{tenant}/{namespace}/maxProducersPerTopic | Set maxProducersPerTopic configuration on a namespace. *NamespacesApi* | [**SetNamespaceAntiAffinityGroup**](docs/NamespacesApi.md#setnamespaceantiaffinitygroup) | **Post** /namespaces/{tenant}/{namespace}/antiAffinity | Set anti-affinity group for a namespace *NamespacesApi* | [**SetNamespaceMessageTTL**](docs/NamespacesApi.md#setnamespacemessagettl) | **Post** /namespaces/{tenant}/{namespace}/messageTTL | Set message TTL in seconds for namespace *NamespacesApi* | [**SetNamespaceReplicationClusters**](docs/NamespacesApi.md#setnamespacereplicationclusters) | **Post** /namespaces/{tenant}/{namespace}/replication | Set the replication clusters for a namespace. *NamespacesApi* | [**SetOffloadDeletionLag**](docs/NamespacesApi.md#setoffloaddeletionlag) | **Put** /namespaces/{tenant}/{namespace}/offloadDeletionLagMs | Set number of milliseconds to wait before deleting a ledger segment which has been offloaded from the Pulsar cluster's local storage (i.e. BookKeeper) *NamespacesApi* | [**SetOffloadThreshold**](docs/NamespacesApi.md#setoffloadthreshold) | **Put** /namespaces/{tenant}/{namespace}/offloadThreshold | Set maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage *NamespacesApi* | [**SetPersistence**](docs/NamespacesApi.md#setpersistence) | **Post** /namespaces/{tenant}/{namespace}/persistence | Set the persistence configuration for all the topics on a namespace. *NamespacesApi* | [**SetReplicatorDispatchRate**](docs/NamespacesApi.md#setreplicatordispatchrate) | **Post** /namespaces/{tenant}/{namespace}/replicatorDispatchRate | Set replicator dispatch-rate throttling for all topics of the namespace *NamespacesApi* | [**SetRetention**](docs/NamespacesApi.md#setretention) | **Post** /namespaces/{tenant}/{namespace}/retention | Set retention configuration on a namespace. *NamespacesApi* | [**SetSchemaAutoUpdateCompatibilityStrategy**](docs/NamespacesApi.md#setschemaautoupdatecompatibilitystrategy) | **Put** /namespaces/{tenant}/{namespace}/schemaAutoUpdateCompatibilityStrategy | Update the strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema *NamespacesApi* | [**SetSchemaValidtionEnforced**](docs/NamespacesApi.md#setschemavalidtionenforced) | **Post** /namespaces/{tenant}/{namespace}/schemaValidationEnforced | Set schema validation enforced flag on namespace. *NamespacesApi* | [**SetSubscribeRate**](docs/NamespacesApi.md#setsubscriberate) | **Post** /namespaces/{tenant}/{namespace}/subscribeRate | Set subscribe-rate throttling for all topics of the namespace *NamespacesApi* | [**SetSubscriptionAuthMode**](docs/NamespacesApi.md#setsubscriptionauthmode) | **Post** /namespaces/{tenant}/{namespace}/subscriptionAuthMode | Set a subscription auth mode for all the topics on a namespace. *NamespacesApi* | [**SetSubscriptionDispatchRate**](docs/NamespacesApi.md#setsubscriptiondispatchrate) | **Post** /namespaces/{tenant}/{namespace}/subscriptionDispatchRate | Set Subscription dispatch-rate throttling for all topics of the namespace *NamespacesApi* | [**SplitNamespaceBundle**](docs/NamespacesApi.md#splitnamespacebundle) | **Put** /namespaces/{tenant}/{namespace}/{bundle}/split | Split a namespace bundle *NamespacesApi* | [**UnloadNamespace**](docs/NamespacesApi.md#unloadnamespace) | **Put** /namespaces/{tenant}/{namespace}/unload | Unload namespace *NamespacesApi* | [**UnloadNamespaceBundle**](docs/NamespacesApi.md#unloadnamespacebundle) | **Put** /namespaces/{tenant}/{namespace}/{bundle}/unload | Unload a namespace bundle *NamespacesApi* | [**UnsubscribeNamespace**](docs/NamespacesApi.md#unsubscribenamespace) | **Post** /namespaces/{tenant}/{namespace}/unsubscribe/{subscription} | Unsubscribes the given subscription on all topics on a namespace. *NamespacesApi* | [**UnsubscribeNamespaceBundle**](docs/NamespacesApi.md#unsubscribenamespacebundle) | **Post** /namespaces/{tenant}/{namespace}/{bundle}/unsubscribe/{subscription} | Unsubscribes the given subscription on all topics on a namespace bundle. *NonPersistentTopicApi* | [**Compact**](docs/NonPersistentTopicApi.md#compact) | **Put** /non-persistent/{tenant}/{namespace}/{topic}/compaction | Trigger a compaction operation on a topic. *NonPersistentTopicApi* | [**CompactionStatus**](docs/NonPersistentTopicApi.md#compactionstatus) | **Get** /non-persistent/{tenant}/{namespace}/{topic}/compaction | Get the status of a compaction operation for a topic. *NonPersistentTopicApi* | [**CreateNonPartitionedTopic**](docs/NonPersistentTopicApi.md#createnonpartitionedtopic) | **Put** /non-persistent/{tenant}/{namespace}/{topic} | Create a non-partitioned topic. *NonPersistentTopicApi* | [**CreatePartitionedTopic**](docs/NonPersistentTopicApi.md#createpartitionedtopic) | **Put** /non-persistent/{tenant}/{namespace}/{topic}/partitions | Create a partitioned topic. *NonPersistentTopicApi* | [**CreateSubscription**](docs/NonPersistentTopicApi.md#createsubscription) | **Put** /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName} | Reset subscription to message position closest to given position. *NonPersistentTopicApi* | [**DeletePartitionedTopic**](docs/NonPersistentTopicApi.md#deletepartitionedtopic) | **Delete** /non-persistent/{tenant}/{namespace}/{topic}/partitions | Delete a partitioned topic. *NonPersistentTopicApi* | [**DeleteSubscription**](docs/NonPersistentTopicApi.md#deletesubscription) | **Delete** /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName} | Delete a subscription. *NonPersistentTopicApi* | [**DeleteTopic**](docs/NonPersistentTopicApi.md#deletetopic) | **Delete** /non-persistent/{tenant}/{namespace}/{topic} | Delete a topic. *NonPersistentTopicApi* | [**ExpireMessagesForAllSubscriptions**](docs/NonPersistentTopicApi.md#expiremessagesforallsubscriptions) | **Post** /non-persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds} | Expiry messages on all subscriptions of topic. *NonPersistentTopicApi* | [**ExpireTopicMessages**](docs/NonPersistentTopicApi.md#expiretopicmessages) | **Post** /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds} | Expiry messages on a topic subscription. *NonPersistentTopicApi* | [**GetBacklog**](docs/NonPersistentTopicApi.md#getbacklog) | **Get** /non-persistent/{tenant}/{namespace}/{topic}/backlog | Get estimated backlog for offline topic. *NonPersistentTopicApi* | [**GetInternalStats**](docs/NonPersistentTopicApi.md#getinternalstats) | **Get** /non-persistent/{tenant}/{namespace}/{topic}/internalStats | Get the internal stats for the topic. *NonPersistentTopicApi* | [**GetLastMessageId**](docs/NonPersistentTopicApi.md#getlastmessageid) | **Get** /non-persistent/{tenant}/{namespace}/{topic}/lastMessageId | Return the last commit message id of topic *NonPersistentTopicApi* | [**GetList**](docs/NonPersistentTopicApi.md#getlist) | **Get** /non-persistent/{tenant}/{namespace} | Get the list of non-persistent topics under a namespace. *NonPersistentTopicApi* | [**GetListFromBundle**](docs/NonPersistentTopicApi.md#getlistfrombundle) | **Get** /non-persistent/{tenant}/{namespace}/{bundle} | Get the list of non-persistent topics under a namespace bundle. *NonPersistentTopicApi* | [**GetManagedLedgerInfo**](docs/NonPersistentTopicApi.md#getmanagedledgerinfo) | **Get** /non-persistent/{tenant}/{namespace}/{topic}/internal-info | Get the internal stats for the topic. *NonPersistentTopicApi* | [**GetPartitionedMetadata**](docs/NonPersistentTopicApi.md#getpartitionedmetadata) | **Get** /non-persistent/{tenant}/{namespace}/{topic}/partitions | Get partitioned topic metadata. *NonPersistentTopicApi* | [**GetPartitionedStats**](docs/NonPersistentTopicApi.md#getpartitionedstats) | **Get** /non-persistent/{tenant}/{namespace}/{topic}/partitioned-stats | Get the stats for the partitioned topic. *NonPersistentTopicApi* | [**GetPartitionedTopicList**](docs/NonPersistentTopicApi.md#getpartitionedtopiclist) | **Get** /non-persistent/{tenant}/{namespace}/partitioned | Get the list of partitioned topics under a namespace. *NonPersistentTopicApi* | [**GetPermissionsOnTopic**](docs/NonPersistentTopicApi.md#getpermissionsontopic) | **Get** /non-persistent/{tenant}/{namespace}/{topic}/permissions | Get permissions on a topic. *NonPersistentTopicApi* | [**GetStats**](docs/NonPersistentTopicApi.md#getstats) | **Get** /non-persistent/{tenant}/{namespace}/{topic}/stats | Get the stats for the topic. *NonPersistentTopicApi* | [**GetSubscriptions**](docs/NonPersistentTopicApi.md#getsubscriptions) | **Get** /non-persistent/{tenant}/{namespace}/{topic}/subscriptions | Get the list of persistent subscriptions for a given topic. *NonPersistentTopicApi* | [**GrantPermissionsOnTopic**](docs/NonPersistentTopicApi.md#grantpermissionsontopic) | **Post** /non-persistent/{tenant}/{namespace}/{topic}/permissions/{role} | Grant a new permission to a role on a single topic. *NonPersistentTopicApi* | [**OffloadStatus**](docs/NonPersistentTopicApi.md#offloadstatus) | **Get** /non-persistent/{tenant}/{namespace}/{topic}/offload | Offload a prefix of a topic to long term storage *NonPersistentTopicApi* | [**PeekNthMessage**](docs/NonPersistentTopicApi.md#peeknthmessage) | **Get** /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition} | Peek nth message on a topic subscription. *NonPersistentTopicApi* | [**ResetCursor**](docs/NonPersistentTopicApi.md#resetcursor) | **Post** /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp} | Reset subscription to message position closest to absolute timestamp (in ms). *NonPersistentTopicApi* | [**ResetCursorOnPosition**](docs/NonPersistentTopicApi.md#resetcursoronposition) | **Post** /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor | Reset subscription to message position closest to given position. *NonPersistentTopicApi* | [**RevokePermissionsOnTopic**](docs/NonPersistentTopicApi.md#revokepermissionsontopic) | **Delete** /non-persistent/{tenant}/{namespace}/{topic}/permissions/{role} | Revoke permissions on a topic. *NonPersistentTopicApi* | [**SkipAllMessages**](docs/NonPersistentTopicApi.md#skipallmessages) | **Post** /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_all | Skip all messages on a topic subscription. *NonPersistentTopicApi* | [**SkipMessages**](docs/NonPersistentTopicApi.md#skipmessages) | **Post** /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages} | Skipping messages on a topic subscription. *NonPersistentTopicApi* | [**Terminate**](docs/NonPersistentTopicApi.md#terminate) | **Post** /non-persistent/{tenant}/{namespace}/{topic}/terminate | Terminate a topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog *NonPersistentTopicApi* | [**TriggerOffload**](docs/NonPersistentTopicApi.md#triggeroffload) | **Put** /non-persistent/{tenant}/{namespace}/{topic}/offload | Offload a prefix of a topic to long term storage *NonPersistentTopicApi* | [**UnloadTopic**](docs/NonPersistentTopicApi.md#unloadtopic) | **Put** /non-persistent/{tenant}/{namespace}/{topic}/unload | Unload a topic *NonPersistentTopicApi* | [**UpdatePartitionedTopic**](docs/NonPersistentTopicApi.md#updatepartitionedtopic) | **Post** /non-persistent/{tenant}/{namespace}/{topic}/partitions | Increment partitons of an existing partitioned topic. *PersistentTopicApi* | [**Compact**](docs/PersistentTopicApi.md#compact) | **Put** /persistent/{tenant}/{namespace}/{topic}/compaction | Trigger a compaction operation on a topic. *PersistentTopicApi* | [**CompactionStatus**](docs/PersistentTopicApi.md#compactionstatus) | **Get** /persistent/{tenant}/{namespace}/{topic}/compaction | Get the status of a compaction operation for a topic. *PersistentTopicApi* | [**CreateNonPartitionedTopic**](docs/PersistentTopicApi.md#createnonpartitionedtopic) | **Put** /persistent/{tenant}/{namespace}/{topic} | Create a non-partitioned topic. *PersistentTopicApi* | [**CreatePartitionedTopic**](docs/PersistentTopicApi.md#createpartitionedtopic) | **Put** /persistent/{tenant}/{namespace}/{topic}/partitions | Create a partitioned topic. *PersistentTopicApi* | [**CreateSubscription**](docs/PersistentTopicApi.md#createsubscription) | **Put** /persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName} | Reset subscription to message position closest to given position. *PersistentTopicApi* | [**DeletePartitionedTopic**](docs/PersistentTopicApi.md#deletepartitionedtopic) | **Delete** /persistent/{tenant}/{namespace}/{topic}/partitions | Delete a partitioned topic. *PersistentTopicApi* | [**DeleteSubscription**](docs/PersistentTopicApi.md#deletesubscription) | **Delete** /persistent/{tenant}/{namespace}/{topic}/subscription/{subName} | Delete a subscription. *PersistentTopicApi* | [**DeleteTopic**](docs/PersistentTopicApi.md#deletetopic) | **Delete** /persistent/{tenant}/{namespace}/{topic} | Delete a topic. *PersistentTopicApi* | [**ExpireMessagesForAllSubscriptions**](docs/PersistentTopicApi.md#expiremessagesforallsubscriptions) | **Post** /persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds} | Expiry messages on all subscriptions of topic. *PersistentTopicApi* | [**ExpireTopicMessages**](docs/PersistentTopicApi.md#expiretopicmessages) | **Post** /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds} | Expiry messages on a topic subscription. *PersistentTopicApi* | [**GetBacklog**](docs/PersistentTopicApi.md#getbacklog) | **Get** /persistent/{tenant}/{namespace}/{topic}/backlog | Get estimated backlog for offline topic. *PersistentTopicApi* | [**GetInternalStats**](docs/PersistentTopicApi.md#getinternalstats) | **Get** /persistent/{tenant}/{namespace}/{topic}/internalStats | Get the internal stats for the topic. *PersistentTopicApi* | [**GetLastMessageId**](docs/PersistentTopicApi.md#getlastmessageid) | **Get** /persistent/{tenant}/{namespace}/{topic}/lastMessageId | Return the last commit message id of topic *PersistentTopicApi* | [**GetList**](docs/PersistentTopicApi.md#getlist) | **Get** /persistent/{tenant}/{namespace} | Get the list of topics under a namespace. *PersistentTopicApi* | [**GetManagedLedgerInfo**](docs/PersistentTopicApi.md#getmanagedledgerinfo) | **Get** /persistent/{tenant}/{namespace}/{topic}/internal-info | Get the internal stats for the topic. *PersistentTopicApi* | [**GetPartitionedMetadata**](docs/PersistentTopicApi.md#getpartitionedmetadata) | **Get** /persistent/{tenant}/{namespace}/{topic}/partitions | Get partitioned topic metadata. *PersistentTopicApi* | [**GetPartitionedStats**](docs/PersistentTopicApi.md#getpartitionedstats) | **Get** /persistent/{tenant}/{namespace}/{topic}/partitioned-stats | Get the stats for the partitioned topic. *PersistentTopicApi* | [**GetPartitionedTopicList**](docs/PersistentTopicApi.md#getpartitionedtopiclist) | **Get** /persistent/{tenant}/{namespace}/partitioned | Get the list of partitioned topics under a namespace. *PersistentTopicApi* | [**GetPermissionsOnTopic**](docs/PersistentTopicApi.md#getpermissionsontopic) | **Get** /persistent/{tenant}/{namespace}/{topic}/permissions | Get permissions on a topic. *PersistentTopicApi* | [**GetStats**](docs/PersistentTopicApi.md#getstats) | **Get** /persistent/{tenant}/{namespace}/{topic}/stats | Get the stats for the topic. *PersistentTopicApi* | [**GetSubscriptions**](docs/PersistentTopicApi.md#getsubscriptions) | **Get** /persistent/{tenant}/{namespace}/{topic}/subscriptions | Get the list of persistent subscriptions for a given topic. *PersistentTopicApi* | [**GrantPermissionsOnTopic**](docs/PersistentTopicApi.md#grantpermissionsontopic) | **Post** /persistent/{tenant}/{namespace}/{topic}/permissions/{role} | Grant a new permission to a role on a single topic. *PersistentTopicApi* | [**OffloadStatus**](docs/PersistentTopicApi.md#offloadstatus) | **Get** /persistent/{tenant}/{namespace}/{topic}/offload | Offload a prefix of a topic to long term storage *PersistentTopicApi* | [**PeekNthMessage**](docs/PersistentTopicApi.md#peeknthmessage) | **Get** /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition} | Peek nth message on a topic subscription. *PersistentTopicApi* | [**ResetCursor**](docs/PersistentTopicApi.md#resetcursor) | **Post** /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp} | Reset subscription to message position closest to absolute timestamp (in ms). *PersistentTopicApi* | [**ResetCursorOnPosition**](docs/PersistentTopicApi.md#resetcursoronposition) | **Post** /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor | Reset subscription to message position closest to given position. *PersistentTopicApi* | [**RevokePermissionsOnTopic**](docs/PersistentTopicApi.md#revokepermissionsontopic) | **Delete** /persistent/{tenant}/{namespace}/{topic}/permissions/{role} | Revoke permissions on a topic. *PersistentTopicApi* | [**SkipAllMessages**](docs/PersistentTopicApi.md#skipallmessages) | **Post** /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_all | Skip all messages on a topic subscription. *PersistentTopicApi* | [**SkipMessages**](docs/PersistentTopicApi.md#skipmessages) | **Post** /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages} | Skipping messages on a topic subscription. *PersistentTopicApi* | [**Terminate**](docs/PersistentTopicApi.md#terminate) | **Post** /persistent/{tenant}/{namespace}/{topic}/terminate | Terminate a topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog *PersistentTopicApi* | [**TriggerOffload**](docs/PersistentTopicApi.md#triggeroffload) | **Put** /persistent/{tenant}/{namespace}/{topic}/offload | Offload a prefix of a topic to long term storage *PersistentTopicApi* | [**UnloadTopic**](docs/PersistentTopicApi.md#unloadtopic) | **Put** /persistent/{tenant}/{namespace}/{topic}/unload | Unload a topic *PersistentTopicApi* | [**UpdatePartitionedTopic**](docs/PersistentTopicApi.md#updatepartitionedtopic) | **Post** /persistent/{tenant}/{namespace}/{topic}/partitions | Increment partitons of an existing partitioned topic. *ResourceQuotasApi* | [**GetDefaultResourceQuota**](docs/ResourceQuotasApi.md#getdefaultresourcequota) | **Get** /resource-quotas | Get the default quota *ResourceQuotasApi* | [**GetNamespaceBundleResourceQuota**](docs/ResourceQuotasApi.md#getnamespacebundleresourcequota) | **Get** /resource-quotas/{tenant}/{namespace}/{bundle} | Get resource quota of a namespace bundle. *ResourceQuotasApi* | [**RemoveNamespaceBundleResourceQuota**](docs/ResourceQuotasApi.md#removenamespacebundleresourcequota) | **Delete** /resource-quotas/{tenant}/{namespace}/{bundle} | Remove resource quota for a namespace. *ResourceQuotasApi* | [**SetDefaultResourceQuota**](docs/ResourceQuotasApi.md#setdefaultresourcequota) | **Post** /resource-quotas | Set the default quota *ResourceQuotasApi* | [**SetNamespaceBundleResourceQuota**](docs/ResourceQuotasApi.md#setnamespacebundleresourcequota) | **Post** /resource-quotas/{tenant}/{namespace}/{bundle} | Set resource quota on a namespace. *SchemasApi* | [**DeleteSchema**](docs/SchemasApi.md#deleteschema) | **Delete** /schemas/{tenant}/{namespace}/{topic}/schema | Delete the schema of a topic *SchemasApi* | [**GetSchema**](docs/SchemasApi.md#getschema) | **Get** /schemas/{tenant}/{namespace}/{topic}/schema | Get the schema of a topic *SchemasApi* | [**GetSchema_0**](docs/SchemasApi.md#getschema_0) | **Get** /schemas/{tenant}/{namespace}/{topic}/schema/{version} | Get the schema of a topic at a given version *SchemasApi* | [**PostSchema**](docs/SchemasApi.md#postschema) | **Post** /schemas/{tenant}/{namespace}/{topic}/schema | Update the schema of a topic *TenantsApi* | [**CreateTenant**](docs/TenantsApi.md#createtenant) | **Put** /tenants/{tenant} | Create a new tenant. *TenantsApi* | [**DeleteTenant**](docs/TenantsApi.md#deletetenant) | **Delete** /tenants/{tenant} | Delete a tenant and all namespaces and topics under it. *TenantsApi* | [**GetTenantAdmin**](docs/TenantsApi.md#gettenantadmin) | **Get** /tenants/{tenant} | Get the admin configuration for a given tenant. *TenantsApi* | [**GetTenants**](docs/TenantsApi.md#gettenants) | **Get** /tenants | Get the list of existing tenants. *TenantsApi* | [**UpdateTenant**](docs/TenantsApi.md#updatetenant) | **Post** /tenants/{tenant} | Update the admins for a tenant. ## Documentation For Models - [AllocatorStats](docs/AllocatorStats.md) - [AuthPolicies](docs/AuthPolicies.md) - [AutoFailoverPolicyData](docs/AutoFailoverPolicyData.md) - [BacklogQuota](docs/BacklogQuota.md) - [BookieAffinityGroupData](docs/BookieAffinityGroupData.md) - [BookieInfo](docs/BookieInfo.md) - [BrokerNamespaceIsolationData](docs/BrokerNamespaceIsolationData.md) - [BundlesData](docs/BundlesData.md) - [ClusterData](docs/ClusterData.md) - [ConsumerStats](docs/ConsumerStats.md) - [CursorDetails](docs/CursorDetails.md) - [CursorStats](docs/CursorStats.md) - [DeleteSchemaResponse](docs/DeleteSchemaResponse.md) - [DispatchRate](docs/DispatchRate.md) - [FailureDomain](docs/FailureDomain.md) - [GetSchemaResponse](docs/GetSchemaResponse.md) - [InternalConfigurationData](docs/InternalConfigurationData.md) - [LedgerDetails](docs/LedgerDetails.md) - [LedgerInfo](docs/LedgerInfo.md) - [LoadReport](docs/LoadReport.md) - [LongRunningProcessStatus](docs/LongRunningProcessStatus.md) - [MessageIdImpl](docs/MessageIdImpl.md) - [Metrics](docs/Metrics.md) - [NamespaceBundleStats](docs/NamespaceBundleStats.md) - [NamespaceIsolationData](docs/NamespaceIsolationData.md) - [NamespaceOwnershipStatus](docs/NamespaceOwnershipStatus.md) - [NonPersistentPublisherStats](docs/NonPersistentPublisherStats.md) - [NonPersistentReplicatorStats](docs/NonPersistentReplicatorStats.md) - [NonPersistentSubscriptionStats](docs/NonPersistentSubscriptionStats.md) - [NonPersistentTopicStats](docs/NonPersistentTopicStats.md) - [OffloadProcessStatus](docs/OffloadProcessStatus.md) - [PartitionedTopicMetadata](docs/PartitionedTopicMetadata.md) - [PendingBookieOpsStats](docs/PendingBookieOpsStats.md) - [PersistencePolicies](docs/PersistencePolicies.md) - [PersistentOfflineTopicStats](docs/PersistentOfflineTopicStats.md) - [PersistentTopicInternalStats](docs/PersistentTopicInternalStats.md) - [Policies](docs/Policies.md) - [PoolArenaStats](docs/PoolArenaStats.md) - [PoolChunkListStats](docs/PoolChunkListStats.md) - [PoolChunkStats](docs/PoolChunkStats.md) - [PoolSubpageStats](docs/PoolSubpageStats.md) - [PostSchemaPayload](docs/PostSchemaPayload.md) - [PostSchemaResponse](docs/PostSchemaResponse.md) - [PublisherStats](docs/PublisherStats.md) - [ReplicatorStats](docs/ReplicatorStats.md) - [ResourceDescription](docs/ResourceDescription.md) - [ResourceQuota](docs/ResourceQuota.md) - [ResourceUnit](docs/ResourceUnit.md) - [ResourceUsage](docs/ResourceUsage.md) - [RetentionPolicies](docs/RetentionPolicies.md) - [SubscribeRate](docs/SubscribeRate.md) - [SubscriptionStats](docs/SubscriptionStats.md) - [SystemResourceUsage](docs/SystemResourceUsage.md) - [TenantInfo](docs/TenantInfo.md) - [TopicStats](docs/TopicStats.md) ## Documentation For Authorization Endpoints do not require authorization. ## Author