Categorygithub.com/fourhu/pulsar-admin-openapi-go

# README

Go API client for openapi

This provides the REST API for admin operations

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: v2
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

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

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

import sw "./openapi"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost/admin/v2

ClassMethodHTTP requestDescription
BookiesApiDeleteBookieRackInfoDelete /bookies/racks-info/{bookie}Removed the rack placement information for a specific bookie in the cluster
BookiesApiGetAllBookiesGet /bookies/allGets raw information for all the bookies in the cluster
BookiesApiGetBookieRackInfoGet /bookies/racks-info/{bookie}Gets the rack placement information for a specific bookie in the cluster
BookiesApiGetBookiesRackInfoGet /bookies/racks-infoGets the rack placement information for all the bookies in the cluster
BookiesApiUpdateBookieRackInfoPost /bookies/racks-info/{bookie}Updates the rack placement information for a specific bookie in the cluster (note. bookie address format:`address:port`)
BrokerStatsApiGetAllocatorStatsGet /broker-stats/allocator-stats/{allocator}Get the stats for the Netty allocator. Available allocators are 'default' and 'ml-cache'
BrokerStatsApiGetBrokerResourceAvailabilityGet /broker-stats/broker-resource-availability/{tenant}/{namespace}Broker availability report
BrokerStatsApiGetLoadReportGet /broker-stats/load-reportGet Load for this broker
BrokerStatsApiGetMBeansGet /broker-stats/mbeansGet all the mbean details of this broker JVM
BrokerStatsApiGetMetricsGet /broker-stats/metricsGets the metrics for Monitoring
BrokerStatsApiGetPendingBookieOpsStatsGet /broker-stats/bookieopsGet pending bookie client op stats by namesapce
BrokerStatsApiGetTopics2Get /broker-stats/topicsGet all the topic stats by namespace
BrokersApiBacklogQuotaCheckGet /brokers/backlog-quota-checkAn REST endpoint to trigger backlogQuotaCheck
BrokersApiDeleteDynamicConfigurationDelete /brokers/configuration/{configName}Delete dynamic serviceconfiguration into zk only. This operation requires Pulsar super-user privileges.
BrokersApiGetActiveBrokersGet /brokers/{cluster}Get the list of active brokers (web service addresses) in the cluster.If authorization is not enabled, any cluster name is valid.
BrokersApiGetAllDynamicConfigurationsGet /brokers/configuration/valuesGet value of all dynamic configurations' value overridden on local config
BrokersApiGetDynamicConfigurationNameGet /brokers/configurationGet all updatable dynamic configurations's name
BrokersApiGetInternalConfigurationDataGet /brokers/internal-configurationGet the internal configuration data
BrokersApiGetLeaderBrokerGet /brokers/leaderBrokerGet the information of the leader broker.
BrokersApiGetOwnedNamespacesGet /brokers/{clusterName}/{broker-webserviceurl}/ownedNamespacesGet the list of namespaces served by the specific broker
BrokersApiGetRuntimeConfigurationGet /brokers/configuration/runtimeGet all runtime configurations. This operation requires Pulsar super-user privileges.
BrokersApiHealthcheckGet /brokers/healthRun a healthcheck against the broker
BrokersApiIsReadyGet /brokers/readyCheck if the broker is fully initialized
BrokersApiUpdateDynamicConfigurationPost /brokers/configuration/{configName}/{configValue}Update dynamic serviceconfiguration into zk only. This operation requires Pulsar super-user privileges.
BrokersApiVersionGet /brokers/versionGet version of current broker
ClustersApiCreateClusterPut /clusters/{cluster}Create a new cluster.
ClustersApiDeleteClusterDelete /clusters/{cluster}Delete an existing cluster.
ClustersApiDeleteFailureDomainDelete /clusters/{cluster}/failureDomains/{domainName}Delete the failure domain of the cluster
ClustersApiDeleteNamespaceIsolationPolicyDelete /clusters/{cluster}/namespaceIsolationPolicies/{policyName}Delete namespace isolation policy.
ClustersApiGetBrokerWithNamespaceIsolationPolicyGet /clusters/{cluster}/namespaceIsolationPolicies/brokers/{broker}Get a broker with namespace-isolation policies attached to it.
ClustersApiGetBrokersWithNamespaceIsolationPolicyGet /clusters/{cluster}/namespaceIsolationPolicies/brokersGet list of brokers with namespace-isolation policies attached to them.
ClustersApiGetClusterGet /clusters/{cluster}Get the configuration for the specified cluster.
ClustersApiGetClustersGet /clustersGet the list of all the Pulsar clusters.
ClustersApiGetDomainGet /clusters/{cluster}/failureDomains/{domainName}Get a domain in a cluster
ClustersApiGetFailureDomainsGet /clusters/{cluster}/failureDomainsGet the cluster failure domains.
ClustersApiGetNamespaceIsolationPoliciesGet /clusters/{cluster}/namespaceIsolationPoliciesGet the namespace isolation policies assigned to the cluster.
ClustersApiGetNamespaceIsolationPolicyGet /clusters/{cluster}/namespaceIsolationPolicies/{policyName}Get the single namespace isolation policy assigned to the cluster.
ClustersApiGetPeerClusterGet /clusters/{cluster}/peersGet the peer-cluster data for the specified cluster.
ClustersApiSetFailureDomainPost /clusters/{cluster}/failureDomains/{domainName}Set the failure domain of the cluster.
ClustersApiSetNamespaceIsolationPolicyPost /clusters/{cluster}/namespaceIsolationPolicies/{policyName}Set namespace isolation policy.
ClustersApiSetPeerClusterNamesPost /clusters/{cluster}/peersUpdate peer-cluster-list for a cluster.
ClustersApiUpdateClusterPost /clusters/{cluster}Update the configuration for a cluster.
DefaultApiGetAssignmentsGet /worker/assignmentsFetches information about which Pulsar Functions are assigned to which Pulsar clusters
DefaultApiGetClusterGet /worker/clusterFetches information about the Pulsar cluster running Pulsar Functions
DefaultApiGetClusterLeaderGet /worker/cluster/leaderFetches info about the leader node of the Pulsar cluster running Pulsar Functions
DefaultApiGetConnectorsListGet /worker/connectorsFetches a list of supported Pulsar IO connectors currently running in cluster mode
DefaultApiGetMetricsGet /worker-stats/metricsGets the metrics for Monitoring
DefaultApiGetStatsGet /worker-stats/functionsmetricsGet metrics for all functions owned by worker
DefaultApiIsLeaderReadyGet /worker/cluster/leader/readyChecks if this node is the leader and is ready to service requests
DefaultApiRebalancePut /worker/rebalanceTriggers a rebalance of functions to workers
NamespacesApiClearNamespaceBacklogPost /namespaces/{tenant}/{namespace}/clearBacklogClear backlog for all topics on a namespace.
NamespacesApiClearNamespaceBacklogForSubscriptionPost /namespaces/{tenant}/{namespace}/clearBacklog/{subscription}Clear backlog for a given subscription on all topics on a namespace.
NamespacesApiClearNamespaceBundleBacklogPost /namespaces/{tenant}/{namespace}/{bundle}/clearBacklogClear backlog for all topics on a namespace bundle.
NamespacesApiClearNamespaceBundleBacklogForSubscriptionPost /namespaces/{tenant}/{namespace}/{bundle}/clearBacklog/{subscription}Clear backlog for a given subscription on all topics on a namespace bundle.
NamespacesApiClearOffloadDeletionLagDelete /namespaces/{tenant}/{namespace}/offloadDeletionLagMsClear the namespace configured offload deletion lag. The topics in the namespace will fallback to using the default configured deletion lag for the broker
NamespacesApiClearPropertiesDelete /namespaces/{tenant}/{namespace}/propertiesGet property value for a given key on a namespace.
NamespacesApiCreateNamespacePut /namespaces/{tenant}/{namespace}Creates a new namespace with the specified policies
NamespacesApiDeleteBookieAffinityGroupDelete /namespaces/{property}/{namespace}/persistence/bookieAffinityDelete the bookie-affinity-group from namespace-local policy.
NamespacesApiDeleteCompactionThresholdDelete /namespaces/{tenant}/{namespace}/compactionThresholdDelete maximum number of uncompacted bytes in a topic before compaction is triggered.
NamespacesApiDeleteDispatchRateDelete /namespaces/{tenant}/{namespace}/dispatchRateDelete dispatch-rate throttling for all topics of the namespace
NamespacesApiDeleteNamespaceDelete /namespaces/{tenant}/{namespace}Delete a namespace and all the topics under it.
NamespacesApiDeleteNamespaceBundleDelete /namespaces/{tenant}/{namespace}/{bundle}Delete a namespace bundle and all the topics under it.
NamespacesApiDeletePersistenceDelete /namespaces/{tenant}/{namespace}/persistenceDelete the persistence configuration for all topics on a namespace
NamespacesApiDeleteSubscribeRateDelete /namespaces/{tenant}/{namespace}/subscribeRateDelete subscribe-rate throttling for all topics of the namespace
NamespacesApiDeleteSubscriptionDispatchRateDelete /namespaces/{tenant}/{namespace}/subscriptionDispatchRateDelete Subscription dispatch-rate throttling for all topics of the namespace
NamespacesApiGetAntiAffinityNamespacesGet /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
NamespacesApiGetBacklogQuotaMapGet /namespaces/{tenant}/{namespace}/backlogQuotaMapGet backlog quota map on a namespace.
NamespacesApiGetBookieAffinityGroupGet /namespaces/{property}/{namespace}/persistence/bookieAffinityGet the bookie-affinity-group from namespace-local policy.
NamespacesApiGetBundlesDataGet /namespaces/{tenant}/{namespace}/bundlesGet the bundles split data.
NamespacesApiGetCompactionThresholdGet /namespaces/{tenant}/{namespace}/compactionThresholdMaximum number of uncompacted bytes in topics before compaction is triggered.
NamespacesApiGetDeduplicationGet /namespaces/{tenant}/{namespace}/deduplicationGet broker side deduplication for all topics in a namespace
NamespacesApiGetDeduplicationSnapshotIntervalGet /namespaces/{tenant}/{namespace}/deduplicationSnapshotIntervalGet deduplicationSnapshotInterval config on a namespace.
NamespacesApiGetDelayedDeliveryPoliciesGet /namespaces/{tenant}/{namespace}/delayedDeliveryGet delayed delivery messages config on a namespace.
NamespacesApiGetDispatchRateGet /namespaces/{tenant}/{namespace}/dispatchRateGet dispatch-rate configured for the namespace, -1 represents not configured yet
NamespacesApiGetInactiveTopicPoliciesGet /namespaces/{tenant}/{namespace}/inactiveTopicPoliciesGet inactive topic policies config on a namespace.
NamespacesApiGetIsAllowAutoUpdateSchemaGet /namespaces/{tenant}/{namespace}/isAllowAutoUpdateSchemaThe flag of whether allow auto update schema
NamespacesApiGetMaxConsumersPerSubscriptionGet /namespaces/{tenant}/{namespace}/maxConsumersPerSubscriptionGet maxConsumersPerSubscription config on a namespace.
NamespacesApiGetMaxConsumersPerTopicGet /namespaces/{tenant}/{namespace}/maxConsumersPerTopicGet maxConsumersPerTopic config on a namespace.
NamespacesApiGetMaxProducersPerTopicGet /namespaces/{tenant}/{namespace}/maxProducersPerTopicGet maxProducersPerTopic config on a namespace.
NamespacesApiGetMaxSubscriptionsPerTopicGet /namespaces/{tenant}/{namespace}/maxSubscriptionsPerTopicGet maxSubscriptionsPerTopic config on a namespace.
NamespacesApiGetMaxTopicsPerNamespaceGet /namespaces/{tenant}/{namespace}/maxTopicsPerNamespaceGet maxTopicsPerNamespace config on a namespace.
NamespacesApiGetMaxUnackedMessagesPerConsumerGet /namespaces/{tenant}/{namespace}/maxUnackedMessagesPerConsumerGet maxUnackedMessagesPerConsumer config on a namespace.
NamespacesApiGetMaxUnackedmessagesPerSubscriptionGet /namespaces/{tenant}/{namespace}/maxUnackedMessagesPerSubscriptionGet maxUnackedMessagesPerSubscription config on a namespace.
NamespacesApiGetNamespaceAntiAffinityGroupGet /namespaces/{tenant}/{namespace}/antiAffinityGet anti-affinity group of a namespace.
NamespacesApiGetNamespaceMessageTTLGet /namespaces/{tenant}/{namespace}/messageTTLGet the message TTL for the namespace
NamespacesApiGetNamespaceReplicationClustersGet /namespaces/{tenant}/{namespace}/replicationGet the replication clusters for a namespace.
NamespacesApiGetNamespaceResourceGroupGet /namespaces/{tenant}/{namespace}/resourcegroupGet the resourcegroup attached to the namespace
NamespacesApiGetOffloadDeletionLagGet /namespaces/{tenant}/{namespace}/offloadDeletionLagMsNumber of milliseconds to wait before deleting a ledger segment which has been offloaded from the Pulsar cluster's local storage (i.e. BookKeeper)
NamespacesApiGetOffloadPoliciesGet /namespaces/{tenant}/{namespace}/offloadPoliciesGet offload configuration on a namespace.
NamespacesApiGetOffloadThresholdGet /namespaces/{tenant}/{namespace}/offloadThresholdMaximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage
NamespacesApiGetPermissionsGet /namespaces/{tenant}/{namespace}/permissionsRetrieve the permissions for a namespace.
NamespacesApiGetPersistenceGet /namespaces/{tenant}/{namespace}/persistenceGet the persistence configuration for a namespace.
NamespacesApiGetPoliciesGet /namespaces/{tenant}/{namespace}Get the dump all the policies specified for a namespace.
NamespacesApiGetPropertiesGet /namespaces/{tenant}/{namespace}/propertiesGet key value pair properties for a given namespace.
NamespacesApiGetPropertyGet /namespaces/{tenant}/{namespace}/property/{key}Get property value for a given key on a namespace.
NamespacesApiGetReplicatorDispatchRateGet /namespaces/{tenant}/{namespace}/replicatorDispatchRateGet replicator dispatch-rate configured for the namespace, -1 represents not configured yet
NamespacesApiGetRetentionGet /namespaces/{tenant}/{namespace}/retentionGet retention config on a namespace.
NamespacesApiGetSchemaAutoUpdateCompatibilityStrategyGet /namespaces/{tenant}/{namespace}/schemaAutoUpdateCompatibilityStrategyThe strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema
NamespacesApiGetSchemaCompatibilityStrategyGet /namespaces/{tenant}/{namespace}/schemaCompatibilityStrategyThe strategy of the namespace schema compatibility
NamespacesApiGetSchemaValidtionEnforcedGet /namespaces/{tenant}/{namespace}/schemaValidationEnforcedGet schema validation enforced flag for namespace.
NamespacesApiGetSubscribeRateGet /namespaces/{tenant}/{namespace}/subscribeRateGet subscribe-rate configured for the namespace
NamespacesApiGetSubscriptionDispatchRateGet /namespaces/{tenant}/{namespace}/subscriptionDispatchRateGet Subscription dispatch-rate configured for the namespace, -1 represents not configured yet
NamespacesApiGetSubscriptionExpirationTimeGet /namespaces/{tenant}/{namespace}/subscriptionExpirationTimeGet the subscription expiration time for the namespace
NamespacesApiGetSubscriptionTypesEnabledGet /namespaces/{tenant}/{namespace}/subscriptionTypesEnabledThe set of whether allow subscription types
NamespacesApiGetTenantNamespacesGet /namespaces/{tenant}Get the list of all the namespaces for a certain tenant.
NamespacesApiGetTopicsGet /namespaces/{tenant}/{namespace}/topicsGet the list of all the topics under a certain namespace.
NamespacesApiGrantPermissionOnNamespacePost /namespaces/{tenant}/{namespace}/permissions/{role}Grant a new permission to a role on a namespace.
NamespacesApiModifyDeduplicationPost /namespaces/{tenant}/{namespace}/deduplicationEnable or disable broker side deduplication for all topics in a namespace
NamespacesApiModifyEncryptionRequiredPost /namespaces/{tenant}/{namespace}/encryptionRequiredMessage encryption is required or not for all topics in a namespace
NamespacesApiRemoveAutoSubscriptionCreationDelete /namespaces/{tenant}/{namespace}/autoSubscriptionCreationRemove override of broker's allowAutoSubscriptionCreation in a namespace
NamespacesApiRemoveAutoTopicCreationDelete /namespaces/{tenant}/{namespace}/autoTopicCreationRemove override of broker's allowAutoTopicCreation in a namespace
NamespacesApiRemoveBacklogQuotaDelete /namespaces/{tenant}/{namespace}/backlogQuotaRemove a backlog quota policy from a namespace.
NamespacesApiRemoveDeduplicationDelete /namespaces/{tenant}/{namespace}/deduplicationRemove broker side deduplication for all topics in a namespace
NamespacesApiRemoveDelayedDeliveryPoliciesDelete /namespaces/{tenant}/{namespace}/delayedDeliveryDelete delayed delivery messages config on a namespace.
NamespacesApiRemoveInactiveTopicPoliciesDelete /namespaces/{tenant}/{namespace}/inactiveTopicPoliciesRemove inactive topic policies from a namespace.
NamespacesApiRemoveMaxConsumersPerSubscriptionDelete /namespaces/{tenant}/{namespace}/maxConsumersPerSubscriptionSet maxConsumersPerSubscription configuration on a namespace.
NamespacesApiRemoveMaxConsumersPerTopicDelete /namespaces/{tenant}/{namespace}/maxConsumersPerTopicRemove maxConsumersPerTopic configuration on a namespace.
NamespacesApiRemoveMaxProducersPerTopicDelete /namespaces/{tenant}/{namespace}/maxProducersPerTopicRemove maxProducersPerTopic configuration on a namespace.
NamespacesApiRemoveMaxSubscriptionsPerTopicDelete /namespaces/{tenant}/{namespace}/maxSubscriptionsPerTopicRemove maxSubscriptionsPerTopic configuration on a namespace.
NamespacesApiRemoveMaxUnackedmessagesPerConsumerDelete /namespaces/{tenant}/{namespace}/maxUnackedMessagesPerConsumerRemove maxUnackedMessagesPerConsumer config on a namespace.
NamespacesApiRemoveMaxUnackedmessagesPerSubscriptionDelete /namespaces/{tenant}/{namespace}/maxUnackedMessagesPerSubscriptionRemove maxUnackedMessagesPerSubscription config on a namespace.
NamespacesApiRemoveNamespaceAntiAffinityGroupDelete /namespaces/{tenant}/{namespace}/antiAffinityRemove anti-affinity group of a namespace.
NamespacesApiRemoveNamespaceMessageTTLDelete /namespaces/{tenant}/{namespace}/messageTTLSet message TTL in seconds for namespace
NamespacesApiRemoveNamespaceResourceGroupDelete /namespaces/{tenant}/{namespace}/resourcegroupDelete resourcegroup for a namespace
NamespacesApiRemoveOffloadPoliciesDelete /namespaces/{tenant}/{namespace}/removeOffloadPoliciesSet offload configuration on a namespace.
NamespacesApiRemovePropertyDelete /namespaces/{tenant}/{namespace}/property/{key}Get property value for a given key on a namespace.
NamespacesApiRemoveReplicatorDispatchRateDelete /namespaces/{tenant}/{namespace}/replicatorDispatchRateRemove replicator dispatch-rate throttling for all topics of the namespace
NamespacesApiRemoveRetentionDelete /namespaces/{tenant}/{namespace}/retentionRemove retention configuration on a namespace.
NamespacesApiRemoveSubscriptionExpirationTimeDelete /namespaces/{tenant}/{namespace}/subscriptionExpirationTimeRemove subscription expiration time for namespace
NamespacesApiRevokePermissionsOnNamespaceDelete /namespaces/{tenant}/{namespace}/permissions/{role}Revoke all permissions to a role on a namespace.
NamespacesApiSetAutoSubscriptionCreationPost /namespaces/{tenant}/{namespace}/autoSubscriptionCreationOverride broker's allowAutoSubscriptionCreation setting for a namespace
NamespacesApiSetAutoTopicCreationPost /namespaces/{tenant}/{namespace}/autoTopicCreationOverride broker's allowAutoTopicCreation setting for a namespace
NamespacesApiSetBacklogQuotaPost /namespaces/{tenant}/{namespace}/backlogQuotaSet a backlog quota for all the topics on a namespace.
NamespacesApiSetBookieAffinityGroupPost /namespaces/{tenant}/{namespace}/persistence/bookieAffinitySet the bookie-affinity-group to namespace-persistent policy.
NamespacesApiSetCompactionThresholdPut /namespaces/{tenant}/{namespace}/compactionThresholdSet maximum number of uncompacted bytes in a topic before compaction is triggered.
NamespacesApiSetDeduplicationSnapshotIntervalPost /namespaces/{tenant}/{namespace}/deduplicationSnapshotIntervalSet deduplicationSnapshotInterval config on a namespace.
NamespacesApiSetDelayedDeliveryPoliciesPost /namespaces/{tenant}/{namespace}/delayedDeliverySet delayed delivery messages config on a namespace.
NamespacesApiSetDispatchRatePost /namespaces/{tenant}/{namespace}/dispatchRateSet dispatch-rate throttling for all topics of the namespace
NamespacesApiSetInactiveTopicPoliciesPost /namespaces/{tenant}/{namespace}/inactiveTopicPoliciesSet inactive topic policies config on a namespace.
NamespacesApiSetInactiveTopicPolicies_0Post /namespaces/{tenant}/{namespace}/maxTopicsPerNamespaceSet maxTopicsPerNamespace config on a namespace.
NamespacesApiSetInactiveTopicPolicies_1Delete /namespaces/{tenant}/{namespace}/maxTopicsPerNamespaceSet maxTopicsPerNamespace config on a namespace.
NamespacesApiSetIsAllowAutoUpdateSchemaPost /namespaces/{tenant}/{namespace}/isAllowAutoUpdateSchemaUpdate flag of whether allow auto update schema
NamespacesApiSetMaxConsumersPerSubscriptionPost /namespaces/{tenant}/{namespace}/maxConsumersPerSubscriptionSet maxConsumersPerSubscription configuration on a namespace.
NamespacesApiSetMaxConsumersPerTopicPost /namespaces/{tenant}/{namespace}/maxConsumersPerTopicSet maxConsumersPerTopic configuration on a namespace.
NamespacesApiSetMaxProducersPerTopicPost /namespaces/{tenant}/{namespace}/maxProducersPerTopicSet maxProducersPerTopic configuration on a namespace.
NamespacesApiSetMaxSubscriptionsPerTopicPost /namespaces/{tenant}/{namespace}/maxSubscriptionsPerTopicSet maxSubscriptionsPerTopic configuration on a namespace.
NamespacesApiSetMaxUnackedMessagesPerConsumerPost /namespaces/{tenant}/{namespace}/maxUnackedMessagesPerConsumerSet maxConsumersPerTopic configuration on a namespace.
NamespacesApiSetMaxUnackedMessagesPerSubscriptionPost /namespaces/{tenant}/{namespace}/maxUnackedMessagesPerSubscriptionSet maxUnackedMessagesPerSubscription configuration on a namespace.
NamespacesApiSetNamespaceAntiAffinityGroupPost /namespaces/{tenant}/{namespace}/antiAffinitySet anti-affinity group for a namespace
NamespacesApiSetNamespaceMessageTTLPost /namespaces/{tenant}/{namespace}/messageTTLSet message TTL in seconds for namespace
NamespacesApiSetNamespaceReplicationClustersPost /namespaces/{tenant}/{namespace}/replicationSet the replication clusters for a namespace.
NamespacesApiSetNamespaceResourceGroupPost /namespaces/{tenant}/{namespace}/resourcegroupSet resourcegroup for a namespace
NamespacesApiSetOffloadDeletionLagPut /namespaces/{tenant}/{namespace}/offloadDeletionLagMsSet number of milliseconds to wait before deleting a ledger segment which has been offloaded from the Pulsar cluster's local storage (i.e. BookKeeper)
NamespacesApiSetOffloadPoliciesPost /namespaces/{tenant}/{namespace}/offloadPoliciesSet offload configuration on a namespace.
NamespacesApiSetOffloadThresholdPut /namespaces/{tenant}/{namespace}/offloadThresholdSet maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage
NamespacesApiSetPersistencePost /namespaces/{tenant}/{namespace}/persistenceSet the persistence configuration for all the topics on a namespace.
NamespacesApiSetPropertiesPut /namespaces/{tenant}/{namespace}/propertiesPut key value pairs property on a namespace.
NamespacesApiSetPropertyPut /namespaces/{tenant}/{namespace}/property/{key}/{value}Put a key value pair property on a namespace.
NamespacesApiSetReplicatorDispatchRatePost /namespaces/{tenant}/{namespace}/replicatorDispatchRateSet replicator dispatch-rate throttling for all topics of the namespace
NamespacesApiSetRetentionPost /namespaces/{tenant}/{namespace}/retentionSet retention configuration on a namespace.
NamespacesApiSetSchemaAutoUpdateCompatibilityStrategyPut /namespaces/{tenant}/{namespace}/schemaAutoUpdateCompatibilityStrategyUpdate the strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema
NamespacesApiSetSchemaCompatibilityStrategyPut /namespaces/{tenant}/{namespace}/schemaCompatibilityStrategyUpdate the strategy used to check the compatibility of new schema
NamespacesApiSetSchemaValidtionEnforcedPost /namespaces/{tenant}/{namespace}/schemaValidationEnforcedSet schema validation enforced flag on namespace.
NamespacesApiSetSubscribeRatePost /namespaces/{tenant}/{namespace}/subscribeRateSet subscribe-rate throttling for all topics of the namespace
NamespacesApiSetSubscriptionAuthModePost /namespaces/{tenant}/{namespace}/subscriptionAuthModeSet a subscription auth mode for all the topics on a namespace.
NamespacesApiSetSubscriptionDispatchRatePost /namespaces/{tenant}/{namespace}/subscriptionDispatchRateSet Subscription dispatch-rate throttling for all topics of the namespace
NamespacesApiSetSubscriptionExpirationTimePost /namespaces/{tenant}/{namespace}/subscriptionExpirationTimeSet subscription expiration time in minutes for namespace
NamespacesApiSetSubscriptionTypesEnabledPost /namespaces/{tenant}/{namespace}/subscriptionTypesEnabledUpdate set of whether allow share sub type
NamespacesApiSplitNamespaceBundlePut /namespaces/{tenant}/{namespace}/{bundle}/splitSplit a namespace bundle
NamespacesApiUnloadNamespacePut /namespaces/{tenant}/{namespace}/unloadUnload namespace
NamespacesApiUnloadNamespaceBundlePut /namespaces/{tenant}/{namespace}/{bundle}/unloadUnload a namespace bundle
NamespacesApiUnsubscribeNamespacePost /namespaces/{tenant}/{namespace}/unsubscribe/{subscription}Unsubscribes the given subscription on all topics on a namespace.
NamespacesApiUnsubscribeNamespaceBundlePost /namespaces/{tenant}/{namespace}/{bundle}/unsubscribe/{subscription}Unsubscribes the given subscription on all topics on a namespace bundle.
NonPersistentTopicApiCompactPut /non-persistent/{tenant}/{namespace}/{topic}/compactionTrigger a compaction operation on a topic.
NonPersistentTopicApiCompactionStatusGet /non-persistent/{tenant}/{namespace}/{topic}/compactionGet the status of a compaction operation for a topic.
NonPersistentTopicApiCreateMissedPartitionsPost /non-persistent/{tenant}/{namespace}/{topic}/createMissedPartitionsCreate missed partitions of an existing partitioned topic.
NonPersistentTopicApiCreateNonPartitionedTopicPut /non-persistent/{tenant}/{namespace}/{topic}Create a non-partitioned topic.
NonPersistentTopicApiCreatePartitionedTopicPut /non-persistent/{tenant}/{namespace}/{topic}/partitionsCreate a partitioned topic.
NonPersistentTopicApiCreateSubscriptionPut /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName}Create a subscription on the topic.
NonPersistentTopicApiDeleteDeduplicationSnapshotIntervalDelete /non-persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotIntervalDelete deduplicationSnapshotInterval config on a topic.
NonPersistentTopicApiDeleteDelayedDeliveryPoliciesDelete /non-persistent/{tenant}/{namespace}/{topic}/delayedDeliverySet delayed delivery messages config on a topic.
NonPersistentTopicApiDeleteInactiveTopicPoliciesDelete /non-persistent/{tenant}/{namespace}/{topic}/inactiveTopicPoliciesDelete inactive topic policies on a topic.
NonPersistentTopicApiDeleteMaxUnackedMessagesOnConsumerDelete /non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumerDelete max unacked messages per consumer config on a topic.
NonPersistentTopicApiDeleteMaxUnackedMessagesOnSubscriptionDelete /non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscriptionDelete max unacked messages per subscription config on a topic.
NonPersistentTopicApiDeletePartitionedTopicDelete /non-persistent/{tenant}/{namespace}/{topic}/partitionsDelete a partitioned topic.
NonPersistentTopicApiDeleteSubscriptionDelete /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}Delete a subscription.
NonPersistentTopicApiDeleteTopicDelete /non-persistent/{tenant}/{namespace}/{topic}Delete a topic.
NonPersistentTopicApiExamineMessageGet /non-persistent/{tenant}/{namespace}/{topic}/examinemessageExamine a specific message on a topic by position relative to the earliest or the latest message.
NonPersistentTopicApiExpireMessagesForAllSubscriptionsPost /non-persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds}Expiry messages on all subscriptions of topic.
NonPersistentTopicApiExpireTopicMessagesPost /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessagesExpiry messages on a topic subscription.
NonPersistentTopicApiExpireTopicMessages_0Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds}Expiry messages on a topic subscription.
NonPersistentTopicApiGetBacklogGet /non-persistent/{tenant}/{namespace}/{topic}/backlogGet estimated backlog for offline topic.
NonPersistentTopicApiGetBacklogQuotaMapGet /non-persistent/{tenant}/{namespace}/{topic}/backlogQuotaMapGet backlog quota map on a topic.
NonPersistentTopicApiGetCompactionThresholdGet /non-persistent/{tenant}/{namespace}/{topic}/compactionThresholdGet compaction threshold configuration for specified topic.
NonPersistentTopicApiGetDeduplicationGet /non-persistent/{tenant}/{namespace}/{topic}/deduplicationEnabledGet deduplication configuration of a topic.
NonPersistentTopicApiGetDeduplicationSnapshotIntervalGet /non-persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotIntervalGet deduplicationSnapshotInterval config on a topic.
NonPersistentTopicApiGetDelayedDeliveryPoliciesGet /non-persistent/{tenant}/{namespace}/{topic}/delayedDeliveryGet delayed delivery messages config on a topic.
NonPersistentTopicApiGetDispatchRateGet /non-persistent/{tenant}/{namespace}/{topic}/dispatchRateGet dispatch rate configuration for specified topic.
NonPersistentTopicApiGetInactiveTopicPoliciesGet /non-persistent/{tenant}/{namespace}/{topic}/inactiveTopicPoliciesGet inactive topic policies on a topic.
NonPersistentTopicApiGetInternalStatsGet /non-persistent/{tenant}/{namespace}/{topic}/internalStatsGet the internal stats for the topic.
NonPersistentTopicApiGetLastMessageIdGet /non-persistent/{tenant}/{namespace}/{topic}/lastMessageIdReturn the last commit message id of topic
NonPersistentTopicApiGetListGet /non-persistent/{tenant}/{namespace}Get the list of non-persistent topics under a namespace.
NonPersistentTopicApiGetListFromBundleGet /non-persistent/{tenant}/{namespace}/{bundle}Get the list of non-persistent topics under a namespace bundle.
NonPersistentTopicApiGetManagedLedgerInfoGet /non-persistent/{tenant}/{namespace}/{topic}/internal-infoGet the stored topic metadata.
NonPersistentTopicApiGetMaxConsumersGet /non-persistent/{tenant}/{namespace}/{topic}/maxConsumersGet maxConsumers config for specified topic.
NonPersistentTopicApiGetMaxConsumersPerSubscriptionGet /non-persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscriptionGet max consumers per subscription configuration for specified topic.
NonPersistentTopicApiGetMaxMessageSizeGet /non-persistent/{tenant}/{namespace}/{topic}/maxMessageSizeGet maxMessageSize config for specified topic.
NonPersistentTopicApiGetMaxProducersGet /non-persistent/{tenant}/{namespace}/{topic}/maxProducersGet maxProducers config for specified topic.
NonPersistentTopicApiGetMaxSubscriptionsPerTopicGet /non-persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopicGet maxSubscriptionsPerTopic config for specified topic.
NonPersistentTopicApiGetMaxUnackedMessagesOnConsumerGet /non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumerGet max unacked messages per consumer config on a topic.
NonPersistentTopicApiGetMaxUnackedMessagesOnSubscriptionGet /non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscriptionGet max unacked messages per subscription config on a topic.
NonPersistentTopicApiGetMessageByIdGet /non-persistent/{tenant}/{namespace}/{topic}/ledger/{ledgerId}/entry/{entryId}Get message by its messageId.
NonPersistentTopicApiGetMessageTTLGet /non-persistent/{tenant}/{namespace}/{topic}/messageTTLGet message TTL in seconds for a topic
NonPersistentTopicApiGetOffloadPoliciesGet /non-persistent/{tenant}/{namespace}/{topic}/offloadPoliciesGet offload policies on a topic.
NonPersistentTopicApiGetPartitionedMetadataGet /non-persistent/{tenant}/{namespace}/{topic}/partitionsGet partitioned topic metadata.
NonPersistentTopicApiGetPartitionedStatsGet /non-persistent/{tenant}/{namespace}/{topic}/partitioned-statsGet the stats for the partitioned topic.
NonPersistentTopicApiGetPartitionedTopicListGet /non-persistent/{tenant}/{namespace}/partitionedGet the list of partitioned topics under a namespace.
NonPersistentTopicApiGetPermissionsOnTopicGet /non-persistent/{tenant}/{namespace}/{topic}/permissionsGet permissions on a topic.
NonPersistentTopicApiGetPersistenceGet /non-persistent/{tenant}/{namespace}/{topic}/persistenceGet configuration of persistence policies for specified topic.
NonPersistentTopicApiGetPublishRateGet /non-persistent/{tenant}/{namespace}/{topic}/publishRateGet publish rate configuration for specified topic.
NonPersistentTopicApiGetReplicatorDispatchRateGet /non-persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRateGet replicatorDispatchRate config for specified topic.
NonPersistentTopicApiGetRetentionGet /non-persistent/{tenant}/{namespace}/{topic}/retentionGet retention configuration for specified topic.
NonPersistentTopicApiGetStatsGet /non-persistent/{tenant}/{namespace}/{topic}/statsGet the stats for the topic.
NonPersistentTopicApiGetSubscribeRateGet /non-persistent/{tenant}/{namespace}/{topic}/subscribeRateGet subscribe rate configuration for specified topic.
NonPersistentTopicApiGetSubscriptionDispatchRateGet /non-persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRateGet subscription message dispatch rate configuration for specified topic.
NonPersistentTopicApiGetSubscriptionTypesEnabledGet /non-persistent/{tenant}/{namespace}/{topic}/subscriptionTypesEnabledGet is enable sub type fors specified topic.
NonPersistentTopicApiGetSubscriptionsGet /non-persistent/{tenant}/{namespace}/{topic}/subscriptionsGet the list of persistent subscriptions for a given topic.
NonPersistentTopicApiGrantPermissionsOnTopicPost /non-persistent/{tenant}/{namespace}/{topic}/permissions/{role}Grant a new permission to a role on a single topic.
NonPersistentTopicApiOffloadStatusGet /non-persistent/{tenant}/{namespace}/{topic}/offloadOffload a prefix of a topic to long term storage
NonPersistentTopicApiPeekNthMessageGet /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition}Peek nth message on a topic subscription.
NonPersistentTopicApiRemoveBacklogQuotaDelete /non-persistent/{tenant}/{namespace}/{topic}/backlogQuotaRemove a backlog quota policy from a topic.
NonPersistentTopicApiRemoveCompactionThresholdDelete /non-persistent/{tenant}/{namespace}/{topic}/compactionThresholdRemove compaction threshold configuration for specified topic.
NonPersistentTopicApiRemoveDeduplicationDelete /non-persistent/{tenant}/{namespace}/{topic}/deduplicationEnabledRemove deduplication configuration for specified topic.
NonPersistentTopicApiRemoveDispatchRateDelete /non-persistent/{tenant}/{namespace}/{topic}/dispatchRateRemove message dispatch rate configuration for specified topic.
NonPersistentTopicApiRemoveMaxConsumersDelete /non-persistent/{tenant}/{namespace}/{topic}/maxConsumersRemove maxConsumers config for specified topic.
NonPersistentTopicApiRemoveMaxConsumersPerSubscriptionDelete /non-persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscriptionRemove max consumers per subscription configuration for specified topic.
NonPersistentTopicApiRemoveMaxMessageSizeDelete /non-persistent/{tenant}/{namespace}/{topic}/maxMessageSizeRemove maxMessageSize config for specified topic.
NonPersistentTopicApiRemoveMaxProducersDelete /non-persistent/{tenant}/{namespace}/{topic}/maxProducersRemove maxProducers config for specified topic.
NonPersistentTopicApiRemoveMaxSubscriptionsPerTopicDelete /non-persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopicRemove maxSubscriptionsPerTopic config for specified topic.
NonPersistentTopicApiRemoveMessageTTLDelete /non-persistent/{tenant}/{namespace}/{topic}/messageTTLRemove message TTL in seconds for a topic
NonPersistentTopicApiRemoveOffloadPoliciesDelete /non-persistent/{tenant}/{namespace}/{topic}/offloadPoliciesDelete offload policies on a topic.
NonPersistentTopicApiRemovePersistenceDelete /non-persistent/{tenant}/{namespace}/{topic}/persistenceRemove configuration of persistence policies for specified topic.
NonPersistentTopicApiRemovePublishRateDelete /non-persistent/{tenant}/{namespace}/{topic}/publishRateRemove message publish rate configuration for specified topic.
NonPersistentTopicApiRemoveReplicatorDispatchRateDelete /non-persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRateRemove replicatorDispatchRate config for specified topic.
NonPersistentTopicApiRemoveRetentionDelete /non-persistent/{tenant}/{namespace}/{topic}/retentionRemove retention configuration for specified topic.
NonPersistentTopicApiRemoveSubscribeRateDelete /non-persistent/{tenant}/{namespace}/{topic}/subscribeRateRemove subscribe rate configuration for specified topic.
NonPersistentTopicApiRemoveSubscriptionDispatchRateDelete /non-persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRateRemove subscription message dispatch rate configuration for specified topic.
NonPersistentTopicApiResetCursorPost /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp}Reset subscription to message position closest to absolute timestamp (in ms).
NonPersistentTopicApiResetCursorOnPositionPost /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursorReset subscription to message position closest to given position.
NonPersistentTopicApiRevokePermissionsOnTopicDelete /non-persistent/{tenant}/{namespace}/{topic}/permissions/{role}Revoke permissions on a topic.
NonPersistentTopicApiSetBacklogQuotaPost /non-persistent/{tenant}/{namespace}/{topic}/backlogQuotaSet a backlog quota for a topic.
NonPersistentTopicApiSetCompactionThresholdPost /non-persistent/{tenant}/{namespace}/{topic}/compactionThresholdSet compaction threshold configuration for specified topic.
NonPersistentTopicApiSetDeduplicationPost /non-persistent/{tenant}/{namespace}/{topic}/deduplicationEnabledSet deduplication enabled on a topic.
NonPersistentTopicApiSetDeduplicationSnapshotIntervalPost /non-persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotIntervalSet deduplicationSnapshotInterval config on a topic.
NonPersistentTopicApiSetDelayedDeliveryPoliciesPost /non-persistent/{tenant}/{namespace}/{topic}/delayedDeliverySet delayed delivery messages config on a topic.
NonPersistentTopicApiSetDispatchRatePost /non-persistent/{tenant}/{namespace}/{topic}/dispatchRateSet message dispatch rate configuration for specified topic.
NonPersistentTopicApiSetInactiveTopicPoliciesPost /non-persistent/{tenant}/{namespace}/{topic}/inactiveTopicPoliciesSet inactive topic policies on a topic.
NonPersistentTopicApiSetMaxConsumersPost /non-persistent/{tenant}/{namespace}/{topic}/maxConsumersSet maxConsumers config for specified topic.
NonPersistentTopicApiSetMaxConsumersPerSubscriptionPost /non-persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscriptionSet max consumers per subscription configuration for specified topic.
NonPersistentTopicApiSetMaxMessageSizePost /non-persistent/{tenant}/{namespace}/{topic}/maxMessageSizeSet maxMessageSize config for specified topic.
NonPersistentTopicApiSetMaxProducersPost /non-persistent/{tenant}/{namespace}/{topic}/maxProducersSet maxProducers config for specified topic.
NonPersistentTopicApiSetMaxSubscriptionsPerTopicPost /non-persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopicSet maxSubscriptionsPerTopic config for specified topic.
NonPersistentTopicApiSetMaxUnackedMessagesOnConsumerPost /non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumerSet max unacked messages per consumer config on a topic.
NonPersistentTopicApiSetMaxUnackedMessagesOnSubscriptionPost /non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscriptionSet max unacked messages per subscription config on a topic.
NonPersistentTopicApiSetMessageTTLPost /non-persistent/{tenant}/{namespace}/{topic}/messageTTLSet message TTL in seconds for a topic
NonPersistentTopicApiSetOffloadPoliciesPost /non-persistent/{tenant}/{namespace}/{topic}/offloadPoliciesSet offload policies on a topic.
NonPersistentTopicApiSetPersistencePost /non-persistent/{tenant}/{namespace}/{topic}/persistenceSet configuration of persistence policies for specified topic.
NonPersistentTopicApiSetPublishRatePost /non-persistent/{tenant}/{namespace}/{topic}/publishRateSet message publish rate configuration for specified topic.
NonPersistentTopicApiSetReplicatedSubscriptionStatusPost /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/replicatedSubscriptionStatusEnable or disable a replicated subscription on a topic.
NonPersistentTopicApiSetReplicatorDispatchRatePost /non-persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRateSet replicatorDispatchRate config for specified topic.
NonPersistentTopicApiSetRetentionPost /non-persistent/{tenant}/{namespace}/{topic}/retentionSet retention configuration for specified topic.
NonPersistentTopicApiSetSubscribeRatePost /non-persistent/{tenant}/{namespace}/{topic}/subscribeRateSet subscribe rate configuration for specified topic.
NonPersistentTopicApiSetSubscriptionDispatchRatePost /non-persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRateSet subscription message dispatch rate configuration for specified topic.
NonPersistentTopicApiSetSubscriptionTypesEnabledPost /non-persistent/{tenant}/{namespace}/{topic}/subscriptionTypesEnabledSet is enable sub types for specified topic
NonPersistentTopicApiSkipAllMessagesPost /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_allSkip all messages on a topic subscription.
NonPersistentTopicApiSkipMessagesPost /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages}Skipping messages on a topic subscription.
NonPersistentTopicApiTerminatePost /non-persistent/{tenant}/{namespace}/{topic}/terminateTerminate 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
NonPersistentTopicApiTerminatePartitionedTopicPost /non-persistent/{tenant}/{namespace}/{topic}/terminate/partitionsTerminate all partitioned 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
NonPersistentTopicApiTriggerOffloadPut /non-persistent/{tenant}/{namespace}/{topic}/offloadOffload a prefix of a topic to long term storage
NonPersistentTopicApiTruncateTopicDelete /non-persistent/{tenant}/{namespace}/{topic}/truncateTruncate a topic.
NonPersistentTopicApiUnloadTopicPut /non-persistent/{tenant}/{namespace}/{topic}/unloadUnload a topic
NonPersistentTopicApiUpdatePartitionedTopicPost /non-persistent/{tenant}/{namespace}/{topic}/partitionsIncrement partitions of an existing partitioned topic.
PersistentTopicApiCompactPut /persistent/{tenant}/{namespace}/{topic}/compactionTrigger a compaction operation on a topic.
PersistentTopicApiCompactionStatusGet /persistent/{tenant}/{namespace}/{topic}/compactionGet the status of a compaction operation for a topic.
PersistentTopicApiCreateMissedPartitionsPost /persistent/{tenant}/{namespace}/{topic}/createMissedPartitionsCreate missed partitions of an existing partitioned topic.
PersistentTopicApiCreateNonPartitionedTopicPut /persistent/{tenant}/{namespace}/{topic}Create a non-partitioned topic.
PersistentTopicApiCreatePartitionedTopicPut /persistent/{tenant}/{namespace}/{topic}/partitionsCreate a partitioned topic.
PersistentTopicApiCreateSubscriptionPut /persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName}Create a subscription on the topic.
PersistentTopicApiDeleteDeduplicationSnapshotIntervalDelete /persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotIntervalDelete deduplicationSnapshotInterval config on a topic.
PersistentTopicApiDeleteDelayedDeliveryPoliciesDelete /persistent/{tenant}/{namespace}/{topic}/delayedDeliverySet delayed delivery messages config on a topic.
PersistentTopicApiDeleteInactiveTopicPoliciesDelete /persistent/{tenant}/{namespace}/{topic}/inactiveTopicPoliciesDelete inactive topic policies on a topic.
PersistentTopicApiDeleteMaxUnackedMessagesOnConsumerDelete /persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumerDelete max unacked messages per consumer config on a topic.
PersistentTopicApiDeleteMaxUnackedMessagesOnSubscriptionDelete /persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscriptionDelete max unacked messages per subscription config on a topic.
PersistentTopicApiDeletePartitionedTopicDelete /persistent/{tenant}/{namespace}/{topic}/partitionsDelete a partitioned topic.
PersistentTopicApiDeleteSubscriptionDelete /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}Delete a subscription.
PersistentTopicApiDeleteTopicDelete /persistent/{tenant}/{namespace}/{topic}Delete a topic.
PersistentTopicApiExamineMessageGet /persistent/{tenant}/{namespace}/{topic}/examinemessageExamine a specific message on a topic by position relative to the earliest or the latest message.
PersistentTopicApiExpireMessagesForAllSubscriptionsPost /persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds}Expiry messages on all subscriptions of topic.
PersistentTopicApiExpireTopicMessagesPost /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessagesExpiry messages on a topic subscription.
PersistentTopicApiExpireTopicMessages_0Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds}Expiry messages on a topic subscription.
PersistentTopicApiGetBacklogGet /persistent/{tenant}/{namespace}/{topic}/backlogGet estimated backlog for offline topic.
PersistentTopicApiGetBacklogQuotaMapGet /persistent/{tenant}/{namespace}/{topic}/backlogQuotaMapGet backlog quota map on a topic.
PersistentTopicApiGetCompactionThresholdGet /persistent/{tenant}/{namespace}/{topic}/compactionThresholdGet compaction threshold configuration for specified topic.
PersistentTopicApiGetDeduplicationGet /persistent/{tenant}/{namespace}/{topic}/deduplicationEnabledGet deduplication configuration of a topic.
PersistentTopicApiGetDeduplicationSnapshotIntervalGet /persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotIntervalGet deduplicationSnapshotInterval config on a topic.
PersistentTopicApiGetDelayedDeliveryPoliciesGet /persistent/{tenant}/{namespace}/{topic}/delayedDeliveryGet delayed delivery messages config on a topic.
PersistentTopicApiGetDispatchRateGet /persistent/{tenant}/{namespace}/{topic}/dispatchRateGet dispatch rate configuration for specified topic.
PersistentTopicApiGetInactiveTopicPoliciesGet /persistent/{tenant}/{namespace}/{topic}/inactiveTopicPoliciesGet inactive topic policies on a topic.
PersistentTopicApiGetInternalStatsGet /persistent/{tenant}/{namespace}/{topic}/internalStatsGet the internal stats for the topic.
PersistentTopicApiGetLastMessageIdGet /persistent/{tenant}/{namespace}/{topic}/lastMessageIdReturn the last commit message id of topic
PersistentTopicApiGetListGet /persistent/{tenant}/{namespace}Get the list of topics under a namespace.
PersistentTopicApiGetManagedLedgerInfoGet /persistent/{tenant}/{namespace}/{topic}/internal-infoGet the stored topic metadata.
PersistentTopicApiGetMaxConsumersGet /persistent/{tenant}/{namespace}/{topic}/maxConsumersGet maxConsumers config for specified topic.
PersistentTopicApiGetMaxConsumersPerSubscriptionGet /persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscriptionGet max consumers per subscription configuration for specified topic.
PersistentTopicApiGetMaxMessageSizeGet /persistent/{tenant}/{namespace}/{topic}/maxMessageSizeGet maxMessageSize config for specified topic.
PersistentTopicApiGetMaxProducersGet /persistent/{tenant}/{namespace}/{topic}/maxProducersGet maxProducers config for specified topic.
PersistentTopicApiGetMaxSubscriptionsPerTopicGet /persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopicGet maxSubscriptionsPerTopic config for specified topic.
PersistentTopicApiGetMaxUnackedMessagesOnConsumerGet /persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumerGet max unacked messages per consumer config on a topic.
PersistentTopicApiGetMaxUnackedMessagesOnSubscriptionGet /persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscriptionGet max unacked messages per subscription config on a topic.
PersistentTopicApiGetMessageByIdGet /persistent/{tenant}/{namespace}/{topic}/ledger/{ledgerId}/entry/{entryId}Get message by its messageId.
PersistentTopicApiGetMessageTTLGet /persistent/{tenant}/{namespace}/{topic}/messageTTLGet message TTL in seconds for a topic
PersistentTopicApiGetOffloadPoliciesGet /persistent/{tenant}/{namespace}/{topic}/offloadPoliciesGet offload policies on a topic.
PersistentTopicApiGetPartitionedMetadataGet /persistent/{tenant}/{namespace}/{topic}/partitionsGet partitioned topic metadata.
PersistentTopicApiGetPartitionedStatsGet /persistent/{tenant}/{namespace}/{topic}/partitioned-statsGet the stats for the partitioned topic.
PersistentTopicApiGetPartitionedTopicListGet /persistent/{tenant}/{namespace}/partitionedGet the list of partitioned topics under a namespace.
PersistentTopicApiGetPermissionsOnTopicGet /persistent/{tenant}/{namespace}/{topic}/permissionsGet permissions on a topic.
PersistentTopicApiGetPersistenceGet /persistent/{tenant}/{namespace}/{topic}/persistenceGet configuration of persistence policies for specified topic.
PersistentTopicApiGetPublishRateGet /persistent/{tenant}/{namespace}/{topic}/publishRateGet publish rate configuration for specified topic.
PersistentTopicApiGetReplicatorDispatchRateGet /persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRateGet replicatorDispatchRate config for specified topic.
PersistentTopicApiGetRetentionGet /persistent/{tenant}/{namespace}/{topic}/retentionGet retention configuration for specified topic.
PersistentTopicApiGetStatsGet /persistent/{tenant}/{namespace}/{topic}/statsGet the stats for the topic.
PersistentTopicApiGetSubscribeRateGet /persistent/{tenant}/{namespace}/{topic}/subscribeRateGet subscribe rate configuration for specified topic.
PersistentTopicApiGetSubscriptionDispatchRateGet /persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRateGet subscription message dispatch rate configuration for specified topic.
PersistentTopicApiGetSubscriptionTypesEnabledGet /persistent/{tenant}/{namespace}/{topic}/subscriptionTypesEnabledGet is enable sub type fors specified topic.
PersistentTopicApiGetSubscriptionsGet /persistent/{tenant}/{namespace}/{topic}/subscriptionsGet the list of persistent subscriptions for a given topic.
PersistentTopicApiGrantPermissionsOnTopicPost /persistent/{tenant}/{namespace}/{topic}/permissions/{role}Grant a new permission to a role on a single topic.
PersistentTopicApiOffloadStatusGet /persistent/{tenant}/{namespace}/{topic}/offloadOffload a prefix of a topic to long term storage
PersistentTopicApiPeekNthMessageGet /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition}Peek nth message on a topic subscription.
PersistentTopicApiRemoveBacklogQuotaDelete /persistent/{tenant}/{namespace}/{topic}/backlogQuotaRemove a backlog quota policy from a topic.
PersistentTopicApiRemoveCompactionThresholdDelete /persistent/{tenant}/{namespace}/{topic}/compactionThresholdRemove compaction threshold configuration for specified topic.
PersistentTopicApiRemoveDeduplicationDelete /persistent/{tenant}/{namespace}/{topic}/deduplicationEnabledRemove deduplication configuration for specified topic.
PersistentTopicApiRemoveDispatchRateDelete /persistent/{tenant}/{namespace}/{topic}/dispatchRateRemove message dispatch rate configuration for specified topic.
PersistentTopicApiRemoveMaxConsumersDelete /persistent/{tenant}/{namespace}/{topic}/maxConsumersRemove maxConsumers config for specified topic.
PersistentTopicApiRemoveMaxConsumersPerSubscriptionDelete /persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscriptionRemove max consumers per subscription configuration for specified topic.
PersistentTopicApiRemoveMaxMessageSizeDelete /persistent/{tenant}/{namespace}/{topic}/maxMessageSizeRemove maxMessageSize config for specified topic.
PersistentTopicApiRemoveMaxProducersDelete /persistent/{tenant}/{namespace}/{topic}/maxProducersRemove maxProducers config for specified topic.
PersistentTopicApiRemoveMaxSubscriptionsPerTopicDelete /persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopicRemove maxSubscriptionsPerTopic config for specified topic.
PersistentTopicApiRemoveMessageTTLDelete /persistent/{tenant}/{namespace}/{topic}/messageTTLRemove message TTL in seconds for a topic
PersistentTopicApiRemoveOffloadPoliciesDelete /persistent/{tenant}/{namespace}/{topic}/offloadPoliciesDelete offload policies on a topic.
PersistentTopicApiRemovePersistenceDelete /persistent/{tenant}/{namespace}/{topic}/persistenceRemove configuration of persistence policies for specified topic.
PersistentTopicApiRemovePublishRateDelete /persistent/{tenant}/{namespace}/{topic}/publishRateRemove message publish rate configuration for specified topic.
PersistentTopicApiRemoveReplicatorDispatchRateDelete /persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRateRemove replicatorDispatchRate config for specified topic.
PersistentTopicApiRemoveRetentionDelete /persistent/{tenant}/{namespace}/{topic}/retentionRemove retention configuration for specified topic.
PersistentTopicApiRemoveSubscribeRateDelete /persistent/{tenant}/{namespace}/{topic}/subscribeRateRemove subscribe rate configuration for specified topic.
PersistentTopicApiRemoveSubscriptionDispatchRateDelete /persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRateRemove subscription message dispatch rate configuration for specified topic.
PersistentTopicApiResetCursorPost /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp}Reset subscription to message position closest to absolute timestamp (in ms).
PersistentTopicApiResetCursorOnPositionPost /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursorReset subscription to message position closest to given position.
PersistentTopicApiRevokePermissionsOnTopicDelete /persistent/{tenant}/{namespace}/{topic}/permissions/{role}Revoke permissions on a topic.
PersistentTopicApiSetBacklogQuotaPost /persistent/{tenant}/{namespace}/{topic}/backlogQuotaSet a backlog quota for a topic.
PersistentTopicApiSetCompactionThresholdPost /persistent/{tenant}/{namespace}/{topic}/compactionThresholdSet compaction threshold configuration for specified topic.
PersistentTopicApiSetDeduplicationPost /persistent/{tenant}/{namespace}/{topic}/deduplicationEnabledSet deduplication enabled on a topic.
PersistentTopicApiSetDeduplicationSnapshotIntervalPost /persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotIntervalSet deduplicationSnapshotInterval config on a topic.
PersistentTopicApiSetDelayedDeliveryPoliciesPost /persistent/{tenant}/{namespace}/{topic}/delayedDeliverySet delayed delivery messages config on a topic.
PersistentTopicApiSetDispatchRatePost /persistent/{tenant}/{namespace}/{topic}/dispatchRateSet message dispatch rate configuration for specified topic.
PersistentTopicApiSetInactiveTopicPoliciesPost /persistent/{tenant}/{namespace}/{topic}/inactiveTopicPoliciesSet inactive topic policies on a topic.
PersistentTopicApiSetMaxConsumersPost /persistent/{tenant}/{namespace}/{topic}/maxConsumersSet maxConsumers config for specified topic.
PersistentTopicApiSetMaxConsumersPerSubscriptionPost /persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscriptionSet max consumers per subscription configuration for specified topic.
PersistentTopicApiSetMaxMessageSizePost /persistent/{tenant}/{namespace}/{topic}/maxMessageSizeSet maxMessageSize config for specified topic.
PersistentTopicApiSetMaxProducersPost /persistent/{tenant}/{namespace}/{topic}/maxProducersSet maxProducers config for specified topic.
PersistentTopicApiSetMaxSubscriptionsPerTopicPost /persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopicSet maxSubscriptionsPerTopic config for specified topic.
PersistentTopicApiSetMaxUnackedMessagesOnConsumerPost /persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumerSet max unacked messages per consumer config on a topic.
PersistentTopicApiSetMaxUnackedMessagesOnSubscriptionPost /persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscriptionSet max unacked messages per subscription config on a topic.
PersistentTopicApiSetMessageTTLPost /persistent/{tenant}/{namespace}/{topic}/messageTTLSet message TTL in seconds for a topic
PersistentTopicApiSetOffloadPoliciesPost /persistent/{tenant}/{namespace}/{topic}/offloadPoliciesSet offload policies on a topic.
PersistentTopicApiSetPersistencePost /persistent/{tenant}/{namespace}/{topic}/persistenceSet configuration of persistence policies for specified topic.
PersistentTopicApiSetPublishRatePost /persistent/{tenant}/{namespace}/{topic}/publishRateSet message publish rate configuration for specified topic.
PersistentTopicApiSetReplicatedSubscriptionStatusPost /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/replicatedSubscriptionStatusEnable or disable a replicated subscription on a topic.
PersistentTopicApiSetReplicatorDispatchRatePost /persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRateSet replicatorDispatchRate config for specified topic.
PersistentTopicApiSetRetentionPost /persistent/{tenant}/{namespace}/{topic}/retentionSet retention configuration for specified topic.
PersistentTopicApiSetSubscribeRatePost /persistent/{tenant}/{namespace}/{topic}/subscribeRateSet subscribe rate configuration for specified topic.
PersistentTopicApiSetSubscriptionDispatchRatePost /persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRateSet subscription message dispatch rate configuration for specified topic.
PersistentTopicApiSetSubscriptionTypesEnabledPost /persistent/{tenant}/{namespace}/{topic}/subscriptionTypesEnabledSet is enable sub types for specified topic
PersistentTopicApiSkipAllMessagesPost /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_allSkip all messages on a topic subscription.
PersistentTopicApiSkipMessagesPost /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages}Skipping messages on a topic subscription.
PersistentTopicApiTerminatePost /persistent/{tenant}/{namespace}/{topic}/terminateTerminate 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
PersistentTopicApiTerminatePartitionedTopicPost /persistent/{tenant}/{namespace}/{topic}/terminate/partitionsTerminate all partitioned 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
PersistentTopicApiTriggerOffloadPut /persistent/{tenant}/{namespace}/{topic}/offloadOffload a prefix of a topic to long term storage
PersistentTopicApiTruncateTopicDelete /persistent/{tenant}/{namespace}/{topic}/truncateTruncate a topic.
PersistentTopicApiUnloadTopicPut /persistent/{tenant}/{namespace}/{topic}/unloadUnload a topic
PersistentTopicApiUpdatePartitionedTopicPost /persistent/{tenant}/{namespace}/{topic}/partitionsIncrement partitions of an existing partitioned topic.
ResourceQuotasApiGetDefaultResourceQuotaGet /resource-quotasGet the default quota
ResourceQuotasApiGetNamespaceBundleResourceQuotaGet /resource-quotas/{tenant}/{namespace}/{bundle}Get resource quota of a namespace bundle.
ResourceQuotasApiRemoveNamespaceBundleResourceQuotaDelete /resource-quotas/{tenant}/{namespace}/{bundle}Remove resource quota for a namespace.
ResourceQuotasApiSetDefaultResourceQuotaPost /resource-quotasSet the default quota
ResourceQuotasApiSetNamespaceBundleResourceQuotaPost /resource-quotas/{tenant}/{namespace}/{bundle}Set resource quota on a namespace.
ResourcegroupsApiCreateOrUpdateResourceGroupPut /resourcegroups/{resourcegroup}Creates a new resourcegroup with the specified rate limiters
ResourcegroupsApiDeleteResourceGroupDelete /resourcegroups/{resourcegroup}Delete a resourcegroup.
ResourcegroupsApiGetResourceGroupGet /resourcegroups/{resourcegroup}Get the rate limiters specified for a resourcegroup.
ResourcegroupsApiGetResourceGroupsGet /resourcegroupsGet the list of all the resourcegroups.
SchemasApiDeleteSchemaDelete /schemas/{tenant}/{namespace}/{topic}/schemaDelete the schema of a topic
SchemasApiGetAllSchemasGet /schemas/{tenant}/{namespace}/{topic}/schemasGet the all schemas of a topic
SchemasApiGetSchemaGet /schemas/{tenant}/{namespace}/{topic}/schemaGet the schema of a topic
SchemasApiGetSchema_0Get /schemas/{tenant}/{namespace}/{topic}/schema/{version}Get the schema of a topic at a given version
SchemasApiGetVersionBySchemaPost /schemas/{tenant}/{namespace}/{topic}/versionget the version of the schema
SchemasApiPostSchemaPost /schemas/{tenant}/{namespace}/{topic}/schemaUpdate the schema of a topic
SchemasApiTestCompatibilityPost /schemas/{tenant}/{namespace}/{topic}/compatibilitytest the schema compatibility
TenantsApiCreateTenantPut /tenants/{tenant}Create a new tenant.
TenantsApiDeleteTenantDelete /tenants/{tenant}Delete a tenant and all namespaces and topics under it.
TenantsApiGetTenantAdminGet /tenants/{tenant}Get the admin configuration for a given tenant.
TenantsApiGetTenantsGet /tenantsGet the list of existing tenants.
TenantsApiUpdateTenantPost /tenants/{tenant}Update the admins for a tenant.

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

# Packages

No description provided by the author