Giters

fourhu / pulsar-admin-openapi-go

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

Class Method HTTP request Description
BookiesApi DeleteBookieRackInfo Delete /bookies/racks-info/{bookie} Removed the rack placement information for a specific bookie in the cluster
BookiesApi GetAllBookies Get /bookies/all Gets raw information for all the bookies in the cluster
BookiesApi GetBookieRackInfo Get /bookies/racks-info/{bookie} Gets the rack placement information for a specific bookie in the cluster
BookiesApi GetBookiesRackInfo Get /bookies/racks-info Gets the rack placement information for all the bookies in the cluster
BookiesApi UpdateBookieRackInfo Post /bookies/racks-info/{bookie} Updates the rack placement information for a specific bookie in the cluster (note. bookie address format:`address:port`)
BrokerStatsApi GetAllocatorStats Get /broker-stats/allocator-stats/{allocator} Get the stats for the Netty allocator. Available allocators are 'default' and 'ml-cache'
BrokerStatsApi GetBrokerResourceAvailability Get /broker-stats/broker-resource-availability/{tenant}/{namespace} Broker availability report
BrokerStatsApi GetLoadReport Get /broker-stats/load-report Get Load for this broker
BrokerStatsApi GetMBeans Get /broker-stats/mbeans Get all the mbean details of this broker JVM
BrokerStatsApi GetMetrics Get /broker-stats/metrics Gets the metrics for Monitoring
BrokerStatsApi GetPendingBookieOpsStats Get /broker-stats/bookieops Get pending bookie client op stats by namesapce
BrokerStatsApi GetTopics2 Get /broker-stats/topics Get all the topic stats by namespace
BrokersApi BacklogQuotaCheck Get /brokers/backlog-quota-check An REST endpoint to trigger backlogQuotaCheck
BrokersApi DeleteDynamicConfiguration Delete /brokers/configuration/{configName} Delete dynamic serviceconfiguration into zk only. This operation requires Pulsar super-user privileges.
BrokersApi 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 Get /brokers/configuration/values Get value of all dynamic configurations' value overridden on local config
BrokersApi GetDynamicConfigurationName Get /brokers/configuration Get all updatable dynamic configurations's name
BrokersApi GetInternalConfigurationData Get /brokers/internal-configuration Get the internal configuration data
BrokersApi GetLeaderBroker Get /brokers/leaderBroker Get the information of the leader broker.
BrokersApi GetOwnedNamespaces Get /brokers/{clusterName}/{broker-webserviceurl}/ownedNamespaces Get the list of namespaces served by the specific broker
BrokersApi GetRuntimeConfiguration Get /brokers/configuration/runtime Get all runtime configurations. This operation requires Pulsar super-user privileges.
BrokersApi Healthcheck Get /brokers/health Run a healthcheck against the broker
BrokersApi IsReady Get /brokers/ready Check if the broker is fully initialized
BrokersApi UpdateDynamicConfiguration Post /brokers/configuration/{configName}/{configValue} Update dynamic serviceconfiguration into zk only. This operation requires Pulsar super-user privileges.
BrokersApi Version Get /brokers/version Get version of current broker
ClustersApi CreateCluster Put /clusters/{cluster} Create a new cluster.
ClustersApi DeleteCluster Delete /clusters/{cluster} Delete an existing cluster.
ClustersApi DeleteFailureDomain Delete /clusters/{cluster}/failureDomains/{domainName} Delete the failure domain of the cluster
ClustersApi DeleteNamespaceIsolationPolicy Delete /clusters/{cluster}/namespaceIsolationPolicies/{policyName} Delete namespace isolation policy.
ClustersApi GetBrokerWithNamespaceIsolationPolicy Get /clusters/{cluster}/namespaceIsolationPolicies/brokers/{broker} Get a broker with namespace-isolation policies attached to it.
ClustersApi GetBrokersWithNamespaceIsolationPolicy Get /clusters/{cluster}/namespaceIsolationPolicies/brokers Get list of brokers with namespace-isolation policies attached to them.
ClustersApi GetCluster Get /clusters/{cluster} Get the configuration for the specified cluster.
ClustersApi GetClusters Get /clusters Get the list of all the Pulsar clusters.
ClustersApi GetDomain Get /clusters/{cluster}/failureDomains/{domainName} Get a domain in a cluster
ClustersApi GetFailureDomains Get /clusters/{cluster}/failureDomains Get the cluster failure domains.
ClustersApi GetNamespaceIsolationPolicies Get /clusters/{cluster}/namespaceIsolationPolicies Get the namespace isolation policies assigned to the cluster.
ClustersApi GetNamespaceIsolationPolicy Get /clusters/{cluster}/namespaceIsolationPolicies/{policyName} Get the single namespace isolation policy assigned to the cluster.
ClustersApi GetPeerCluster Get /clusters/{cluster}/peers Get the peer-cluster data for the specified cluster.
ClustersApi SetFailureDomain Post /clusters/{cluster}/failureDomains/{domainName} Set the failure domain of the cluster.
ClustersApi SetNamespaceIsolationPolicy Post /clusters/{cluster}/namespaceIsolationPolicies/{policyName} Set namespace isolation policy.
ClustersApi SetPeerClusterNames Post /clusters/{cluster}/peers Update peer-cluster-list for a cluster.
ClustersApi UpdateCluster Post /clusters/{cluster} Update the configuration for a cluster.
DefaultApi GetAssignments Get /worker/assignments Fetches information about which Pulsar Functions are assigned to which Pulsar clusters
DefaultApi GetCluster Get /worker/cluster Fetches information about the Pulsar cluster running Pulsar Functions
DefaultApi GetClusterLeader Get /worker/cluster/leader Fetches info about the leader node of the Pulsar cluster running Pulsar Functions
DefaultApi GetConnectorsList Get /worker/connectors Fetches a list of supported Pulsar IO connectors currently running in cluster mode
DefaultApi GetMetrics Get /worker-stats/metrics Gets the metrics for Monitoring
DefaultApi GetStats Get /worker-stats/functionsmetrics Get metrics for all functions owned by worker
DefaultApi IsLeaderReady Get /worker/cluster/leader/ready Checks if this node is the leader and is ready to service requests
DefaultApi Rebalance Put /worker/rebalance Triggers a rebalance of functions to workers
NamespacesApi ClearNamespaceBacklog Post /namespaces/{tenant}/{namespace}/clearBacklog Clear backlog for all topics on a namespace.
NamespacesApi ClearNamespaceBacklogForSubscription Post /namespaces/{tenant}/{namespace}/clearBacklog/{subscription} Clear backlog for a given subscription on all topics on a namespace.
NamespacesApi ClearNamespaceBundleBacklog Post /namespaces/{tenant}/{namespace}/{bundle}/clearBacklog Clear backlog for all topics on a namespace bundle.
NamespacesApi ClearNamespaceBundleBacklogForSubscription Post /namespaces/{tenant}/{namespace}/{bundle}/clearBacklog/{subscription} Clear backlog for a given subscription on all topics on a namespace bundle.
NamespacesApi 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 ClearProperties Delete /namespaces/{tenant}/{namespace}/properties Get property value for a given key on a namespace.
NamespacesApi CreateNamespace Put /namespaces/{tenant}/{namespace} Creates a new namespace with the specified policies
NamespacesApi DeleteBookieAffinityGroup Delete /namespaces/{property}/{namespace}/persistence/bookieAffinity Delete the bookie-affinity-group from namespace-local policy.
NamespacesApi DeleteCompactionThreshold Delete /namespaces/{tenant}/{namespace}/compactionThreshold Delete maximum number of uncompacted bytes in a topic before compaction is triggered.
NamespacesApi DeleteDispatchRate Delete /namespaces/{tenant}/{namespace}/dispatchRate Delete dispatch-rate throttling for all topics of the namespace
NamespacesApi DeleteNamespace Delete /namespaces/{tenant}/{namespace} Delete a namespace and all the topics under it.
NamespacesApi DeleteNamespaceBundle Delete /namespaces/{tenant}/{namespace}/{bundle} Delete a namespace bundle and all the topics under it.
NamespacesApi DeletePersistence Delete /namespaces/{tenant}/{namespace}/persistence Delete the persistence configuration for all topics on a namespace
NamespacesApi DeleteSubscribeRate Delete /namespaces/{tenant}/{namespace}/subscribeRate Delete subscribe-rate throttling for all topics of the namespace
NamespacesApi DeleteSubscriptionDispatchRate Delete /namespaces/{tenant}/{namespace}/subscriptionDispatchRate Delete Subscription dispatch-rate throttling for all topics of the namespace
NamespacesApi 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 Get /namespaces/{tenant}/{namespace}/backlogQuotaMap Get backlog quota map on a namespace.
NamespacesApi GetBookieAffinityGroup Get /namespaces/{property}/{namespace}/persistence/bookieAffinity Get the bookie-affinity-group from namespace-local policy.
NamespacesApi GetBundlesData Get /namespaces/{tenant}/{namespace}/bundles Get the bundles split data.
NamespacesApi GetCompactionThreshold Get /namespaces/{tenant}/{namespace}/compactionThreshold Maximum number of uncompacted bytes in topics before compaction is triggered.
NamespacesApi GetDeduplication Get /namespaces/{tenant}/{namespace}/deduplication Get broker side deduplication for all topics in a namespace
NamespacesApi GetDeduplicationSnapshotInterval Get /namespaces/{tenant}/{namespace}/deduplicationSnapshotInterval Get deduplicationSnapshotInterval config on a namespace.
NamespacesApi GetDelayedDeliveryPolicies Get /namespaces/{tenant}/{namespace}/delayedDelivery Get delayed delivery messages config on a namespace.
NamespacesApi GetDispatchRate Get /namespaces/{tenant}/{namespace}/dispatchRate Get dispatch-rate configured for the namespace, -1 represents not configured yet
NamespacesApi GetInactiveTopicPolicies Get /namespaces/{tenant}/{namespace}/inactiveTopicPolicies Get inactive topic policies config on a namespace.
NamespacesApi GetIsAllowAutoUpdateSchema Get /namespaces/{tenant}/{namespace}/isAllowAutoUpdateSchema The flag of whether allow auto update schema
NamespacesApi GetMaxConsumersPerSubscription Get /namespaces/{tenant}/{namespace}/maxConsumersPerSubscription Get maxConsumersPerSubscription config on a namespace.
NamespacesApi GetMaxConsumersPerTopic Get /namespaces/{tenant}/{namespace}/maxConsumersPerTopic Get maxConsumersPerTopic config on a namespace.
NamespacesApi GetMaxProducersPerTopic Get /namespaces/{tenant}/{namespace}/maxProducersPerTopic Get maxProducersPerTopic config on a namespace.
NamespacesApi GetMaxSubscriptionsPerTopic Get /namespaces/{tenant}/{namespace}/maxSubscriptionsPerTopic Get maxSubscriptionsPerTopic config on a namespace.
NamespacesApi GetMaxTopicsPerNamespace Get /namespaces/{tenant}/{namespace}/maxTopicsPerNamespace Get maxTopicsPerNamespace config on a namespace.
NamespacesApi GetMaxUnackedMessagesPerConsumer Get /namespaces/{tenant}/{namespace}/maxUnackedMessagesPerConsumer Get maxUnackedMessagesPerConsumer config on a namespace.
NamespacesApi GetMaxUnackedmessagesPerSubscription Get /namespaces/{tenant}/{namespace}/maxUnackedMessagesPerSubscription Get maxUnackedMessagesPerSubscription config on a namespace.
NamespacesApi GetNamespaceAntiAffinityGroup Get /namespaces/{tenant}/{namespace}/antiAffinity Get anti-affinity group of a namespace.
NamespacesApi GetNamespaceMessageTTL Get /namespaces/{tenant}/{namespace}/messageTTL Get the message TTL for the namespace
NamespacesApi GetNamespaceReplicationClusters Get /namespaces/{tenant}/{namespace}/replication Get the replication clusters for a namespace.
NamespacesApi GetNamespaceResourceGroup Get /namespaces/{tenant}/{namespace}/resourcegroup Get the resourcegroup attached to the namespace
NamespacesApi 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 GetOffloadPolicies Get /namespaces/{tenant}/{namespace}/offloadPolicies Get offload configuration on a namespace.
NamespacesApi 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 Get /namespaces/{tenant}/{namespace}/permissions Retrieve the permissions for a namespace.
NamespacesApi GetPersistence Get /namespaces/{tenant}/{namespace}/persistence Get the persistence configuration for a namespace.
NamespacesApi GetPolicies Get /namespaces/{tenant}/{namespace} Get the dump all the policies specified for a namespace.
NamespacesApi GetProperties Get /namespaces/{tenant}/{namespace}/properties Get key value pair properties for a given namespace.
NamespacesApi GetProperty Get /namespaces/{tenant}/{namespace}/property/{key} Get property value for a given key on a namespace.
NamespacesApi GetReplicatorDispatchRate Get /namespaces/{tenant}/{namespace}/replicatorDispatchRate Get replicator dispatch-rate configured for the namespace, -1 represents not configured yet
NamespacesApi GetRetention Get /namespaces/{tenant}/{namespace}/retention Get retention config on a namespace.
NamespacesApi 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 GetSchemaCompatibilityStrategy Get /namespaces/{tenant}/{namespace}/schemaCompatibilityStrategy The strategy of the namespace schema compatibility
NamespacesApi GetSchemaValidtionEnforced Get /namespaces/{tenant}/{namespace}/schemaValidationEnforced Get schema validation enforced flag for namespace.
NamespacesApi GetSubscribeRate Get /namespaces/{tenant}/{namespace}/subscribeRate Get subscribe-rate configured for the namespace
NamespacesApi GetSubscriptionDispatchRate Get /namespaces/{tenant}/{namespace}/subscriptionDispatchRate Get Subscription dispatch-rate configured for the namespace, -1 represents not configured yet
NamespacesApi GetSubscriptionExpirationTime Get /namespaces/{tenant}/{namespace}/subscriptionExpirationTime Get the subscription expiration time for the namespace
NamespacesApi GetSubscriptionTypesEnabled Get /namespaces/{tenant}/{namespace}/subscriptionTypesEnabled The set of whether allow subscription types
NamespacesApi GetTenantNamespaces Get /namespaces/{tenant} Get the list of all the namespaces for a certain tenant.
NamespacesApi GetTopics Get /namespaces/{tenant}/{namespace}/topics Get the list of all the topics under a certain namespace.
NamespacesApi GrantPermissionOnNamespace Post /namespaces/{tenant}/{namespace}/permissions/{role} Grant a new permission to a role on a namespace.
NamespacesApi ModifyDeduplication Post /namespaces/{tenant}/{namespace}/deduplication Enable or disable broker side deduplication for all topics in a namespace
NamespacesApi ModifyEncryptionRequired Post /namespaces/{tenant}/{namespace}/encryptionRequired Message encryption is required or not for all topics in a namespace
NamespacesApi RemoveAutoSubscriptionCreation Delete /namespaces/{tenant}/{namespace}/autoSubscriptionCreation Remove override of broker's allowAutoSubscriptionCreation in a namespace
NamespacesApi RemoveAutoTopicCreation Delete /namespaces/{tenant}/{namespace}/autoTopicCreation Remove override of broker's allowAutoTopicCreation in a namespace
NamespacesApi RemoveBacklogQuota Delete /namespaces/{tenant}/{namespace}/backlogQuota Remove a backlog quota policy from a namespace.
NamespacesApi RemoveDeduplication Delete /namespaces/{tenant}/{namespace}/deduplication Remove broker side deduplication for all topics in a namespace
NamespacesApi RemoveDelayedDeliveryPolicies Delete /namespaces/{tenant}/{namespace}/delayedDelivery Delete delayed delivery messages config on a namespace.
NamespacesApi RemoveInactiveTopicPolicies Delete /namespaces/{tenant}/{namespace}/inactiveTopicPolicies Remove inactive topic policies from a namespace.
NamespacesApi RemoveMaxConsumersPerSubscription Delete /namespaces/{tenant}/{namespace}/maxConsumersPerSubscription Set maxConsumersPerSubscription configuration on a namespace.
NamespacesApi RemoveMaxConsumersPerTopic Delete /namespaces/{tenant}/{namespace}/maxConsumersPerTopic Remove maxConsumersPerTopic configuration on a namespace.
NamespacesApi RemoveMaxProducersPerTopic Delete /namespaces/{tenant}/{namespace}/maxProducersPerTopic Remove maxProducersPerTopic configuration on a namespace.
NamespacesApi RemoveMaxSubscriptionsPerTopic Delete /namespaces/{tenant}/{namespace}/maxSubscriptionsPerTopic Remove maxSubscriptionsPerTopic configuration on a namespace.
NamespacesApi RemoveMaxUnackedmessagesPerConsumer Delete /namespaces/{tenant}/{namespace}/maxUnackedMessagesPerConsumer Remove maxUnackedMessagesPerConsumer config on a namespace.
NamespacesApi RemoveMaxUnackedmessagesPerSubscription Delete /namespaces/{tenant}/{namespace}/maxUnackedMessagesPerSubscription Remove maxUnackedMessagesPerSubscription config on a namespace.
NamespacesApi RemoveNamespaceAntiAffinityGroup Delete /namespaces/{tenant}/{namespace}/antiAffinity Remove anti-affinity group of a namespace.
NamespacesApi RemoveNamespaceMessageTTL Delete /namespaces/{tenant}/{namespace}/messageTTL Set message TTL in seconds for namespace
NamespacesApi RemoveNamespaceResourceGroup Delete /namespaces/{tenant}/{namespace}/resourcegroup Delete resourcegroup for a namespace
NamespacesApi RemoveOffloadPolicies Delete /namespaces/{tenant}/{namespace}/removeOffloadPolicies Set offload configuration on a namespace.
NamespacesApi RemoveProperty Delete /namespaces/{tenant}/{namespace}/property/{key} Get property value for a given key on a namespace.
NamespacesApi RemoveReplicatorDispatchRate Delete /namespaces/{tenant}/{namespace}/replicatorDispatchRate Remove replicator dispatch-rate throttling for all topics of the namespace
NamespacesApi RemoveRetention Delete /namespaces/{tenant}/{namespace}/retention Remove retention configuration on a namespace.
NamespacesApi RemoveSubscriptionExpirationTime Delete /namespaces/{tenant}/{namespace}/subscriptionExpirationTime Remove subscription expiration time for namespace
NamespacesApi RevokePermissionsOnNamespace Delete /namespaces/{tenant}/{namespace}/permissions/{role} Revoke all permissions to a role on a namespace.
NamespacesApi SetAutoSubscriptionCreation Post /namespaces/{tenant}/{namespace}/autoSubscriptionCreation Override broker's allowAutoSubscriptionCreation setting for a namespace
NamespacesApi SetAutoTopicCreation Post /namespaces/{tenant}/{namespace}/autoTopicCreation Override broker's allowAutoTopicCreation setting for a namespace
NamespacesApi SetBacklogQuota Post /namespaces/{tenant}/{namespace}/backlogQuota Set a backlog quota for all the topics on a namespace.
NamespacesApi SetBookieAffinityGroup Post /namespaces/{tenant}/{namespace}/persistence/bookieAffinity Set the bookie-affinity-group to namespace-persistent policy.
NamespacesApi SetCompactionThreshold Put /namespaces/{tenant}/{namespace}/compactionThreshold Set maximum number of uncompacted bytes in a topic before compaction is triggered.
NamespacesApi SetDeduplicationSnapshotInterval Post /namespaces/{tenant}/{namespace}/deduplicationSnapshotInterval Set deduplicationSnapshotInterval config on a namespace.
NamespacesApi SetDelayedDeliveryPolicies Post /namespaces/{tenant}/{namespace}/delayedDelivery Set delayed delivery messages config on a namespace.
NamespacesApi SetDispatchRate Post /namespaces/{tenant}/{namespace}/dispatchRate Set dispatch-rate throttling for all topics of the namespace
NamespacesApi SetInactiveTopicPolicies Post /namespaces/{tenant}/{namespace}/inactiveTopicPolicies Set inactive topic policies config on a namespace.
NamespacesApi SetInactiveTopicPolicies_0 Post /namespaces/{tenant}/{namespace}/maxTopicsPerNamespace Set maxTopicsPerNamespace config on a namespace.
NamespacesApi SetInactiveTopicPolicies_1 Delete /namespaces/{tenant}/{namespace}/maxTopicsPerNamespace Set maxTopicsPerNamespace config on a namespace.
NamespacesApi SetIsAllowAutoUpdateSchema Post /namespaces/{tenant}/{namespace}/isAllowAutoUpdateSchema Update flag of whether allow auto update schema
NamespacesApi SetMaxConsumersPerSubscription Post /namespaces/{tenant}/{namespace}/maxConsumersPerSubscription Set maxConsumersPerSubscription configuration on a namespace.
NamespacesApi SetMaxConsumersPerTopic Post /namespaces/{tenant}/{namespace}/maxConsumersPerTopic Set maxConsumersPerTopic configuration on a namespace.
NamespacesApi SetMaxProducersPerTopic Post /namespaces/{tenant}/{namespace}/maxProducersPerTopic Set maxProducersPerTopic configuration on a namespace.
NamespacesApi SetMaxSubscriptionsPerTopic Post /namespaces/{tenant}/{namespace}/maxSubscriptionsPerTopic Set maxSubscriptionsPerTopic configuration on a namespace.
NamespacesApi SetMaxUnackedMessagesPerConsumer Post /namespaces/{tenant}/{namespace}/maxUnackedMessagesPerConsumer Set maxConsumersPerTopic configuration on a namespace.
NamespacesApi SetMaxUnackedMessagesPerSubscription Post /namespaces/{tenant}/{namespace}/maxUnackedMessagesPerSubscription Set maxUnackedMessagesPerSubscription configuration on a namespace.
NamespacesApi SetNamespaceAntiAffinityGroup Post /namespaces/{tenant}/{namespace}/antiAffinity Set anti-affinity group for a namespace
NamespacesApi SetNamespaceMessageTTL Post /namespaces/{tenant}/{namespace}/messageTTL Set message TTL in seconds for namespace
NamespacesApi SetNamespaceReplicationClusters Post /namespaces/{tenant}/{namespace}/replication Set the replication clusters for a namespace.
NamespacesApi SetNamespaceResourceGroup Post /namespaces/{tenant}/{namespace}/resourcegroup Set resourcegroup for a namespace
NamespacesApi 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 SetOffloadPolicies Post /namespaces/{tenant}/{namespace}/offloadPolicies Set offload configuration on a namespace.
NamespacesApi 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 Post /namespaces/{tenant}/{namespace}/persistence Set the persistence configuration for all the topics on a namespace.
NamespacesApi SetProperties Put /namespaces/{tenant}/{namespace}/properties Put key value pairs property on a namespace.
NamespacesApi SetProperty Put /namespaces/{tenant}/{namespace}/property/{key}/{value} Put a key value pair property on a namespace.
NamespacesApi SetReplicatorDispatchRate Post /namespaces/{tenant}/{namespace}/replicatorDispatchRate Set replicator dispatch-rate throttling for all topics of the namespace
NamespacesApi SetRetention Post /namespaces/{tenant}/{namespace}/retention Set retention configuration on a namespace.
NamespacesApi 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 SetSchemaCompatibilityStrategy Put /namespaces/{tenant}/{namespace}/schemaCompatibilityStrategy Update the strategy used to check the compatibility of new schema
NamespacesApi SetSchemaValidtionEnforced Post /namespaces/{tenant}/{namespace}/schemaValidationEnforced Set schema validation enforced flag on namespace.
NamespacesApi SetSubscribeRate Post /namespaces/{tenant}/{namespace}/subscribeRate Set subscribe-rate throttling for all topics of the namespace
NamespacesApi SetSubscriptionAuthMode Post /namespaces/{tenant}/{namespace}/subscriptionAuthMode Set a subscription auth mode for all the topics on a namespace.
NamespacesApi SetSubscriptionDispatchRate Post /namespaces/{tenant}/{namespace}/subscriptionDispatchRate Set Subscription dispatch-rate throttling for all topics of the namespace
NamespacesApi SetSubscriptionExpirationTime Post /namespaces/{tenant}/{namespace}/subscriptionExpirationTime Set subscription expiration time in minutes for namespace
NamespacesApi SetSubscriptionTypesEnabled Post /namespaces/{tenant}/{namespace}/subscriptionTypesEnabled Update set of whether allow share sub type
NamespacesApi SplitNamespaceBundle Put /namespaces/{tenant}/{namespace}/{bundle}/split Split a namespace bundle
NamespacesApi UnloadNamespace Put /namespaces/{tenant}/{namespace}/unload Unload namespace
NamespacesApi UnloadNamespaceBundle Put /namespaces/{tenant}/{namespace}/{bundle}/unload Unload a namespace bundle
NamespacesApi UnsubscribeNamespace Post /namespaces/{tenant}/{namespace}/unsubscribe/{subscription} Unsubscribes the given subscription on all topics on a namespace.
NamespacesApi UnsubscribeNamespaceBundle Post /namespaces/{tenant}/{namespace}/{bundle}/unsubscribe/{subscription} Unsubscribes the given subscription on all topics on a namespace bundle.
NonPersistentTopicApi Compact Put /non-persistent/{tenant}/{namespace}/{topic}/compaction Trigger a compaction operation on a topic.
NonPersistentTopicApi CompactionStatus Get /non-persistent/{tenant}/{namespace}/{topic}/compaction Get the status of a compaction operation for a topic.
NonPersistentTopicApi CreateMissedPartitions Post /non-persistent/{tenant}/{namespace}/{topic}/createMissedPartitions Create missed partitions of an existing partitioned topic.
NonPersistentTopicApi CreateNonPartitionedTopic Put /non-persistent/{tenant}/{namespace}/{topic} Create a non-partitioned topic.
NonPersistentTopicApi CreatePartitionedTopic Put /non-persistent/{tenant}/{namespace}/{topic}/partitions Create a partitioned topic.
NonPersistentTopicApi CreateSubscription Put /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName} Create a subscription on the topic.
NonPersistentTopicApi DeleteDeduplicationSnapshotInterval Delete /non-persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotInterval Delete deduplicationSnapshotInterval config on a topic.
NonPersistentTopicApi DeleteDelayedDeliveryPolicies Delete /non-persistent/{tenant}/{namespace}/{topic}/delayedDelivery Set delayed delivery messages config on a topic.
NonPersistentTopicApi DeleteInactiveTopicPolicies Delete /non-persistent/{tenant}/{namespace}/{topic}/inactiveTopicPolicies Delete inactive topic policies on a topic.
NonPersistentTopicApi DeleteMaxUnackedMessagesOnConsumer Delete /non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumer Delete max unacked messages per consumer config on a topic.
NonPersistentTopicApi DeleteMaxUnackedMessagesOnSubscription Delete /non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscription Delete max unacked messages per subscription config on a topic.
NonPersistentTopicApi DeletePartitionedTopic Delete /non-persistent/{tenant}/{namespace}/{topic}/partitions Delete a partitioned topic.
NonPersistentTopicApi DeleteSubscription Delete /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName} Delete a subscription.
NonPersistentTopicApi DeleteTopic Delete /non-persistent/{tenant}/{namespace}/{topic} Delete a topic.
NonPersistentTopicApi ExamineMessage Get /non-persistent/{tenant}/{namespace}/{topic}/examinemessage Examine a specific message on a topic by position relative to the earliest or the latest message.
NonPersistentTopicApi ExpireMessagesForAllSubscriptions Post /non-persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds} Expiry messages on all subscriptions of topic.
NonPersistentTopicApi ExpireTopicMessages Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages Expiry messages on a topic subscription.
NonPersistentTopicApi ExpireTopicMessages_0 Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds} Expiry messages on a topic subscription.
NonPersistentTopicApi GetBacklog Get /non-persistent/{tenant}/{namespace}/{topic}/backlog Get estimated backlog for offline topic.
NonPersistentTopicApi GetBacklogQuotaMap Get /non-persistent/{tenant}/{namespace}/{topic}/backlogQuotaMap Get backlog quota map on a topic.
NonPersistentTopicApi GetCompactionThreshold Get /non-persistent/{tenant}/{namespace}/{topic}/compactionThreshold Get compaction threshold configuration for specified topic.
NonPersistentTopicApi GetDeduplication Get /non-persistent/{tenant}/{namespace}/{topic}/deduplicationEnabled Get deduplication configuration of a topic.
NonPersistentTopicApi GetDeduplicationSnapshotInterval Get /non-persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotInterval Get deduplicationSnapshotInterval config on a topic.
NonPersistentTopicApi GetDelayedDeliveryPolicies Get /non-persistent/{tenant}/{namespace}/{topic}/delayedDelivery Get delayed delivery messages config on a topic.
NonPersistentTopicApi GetDispatchRate Get /non-persistent/{tenant}/{namespace}/{topic}/dispatchRate Get dispatch rate configuration for specified topic.
NonPersistentTopicApi GetInactiveTopicPolicies Get /non-persistent/{tenant}/{namespace}/{topic}/inactiveTopicPolicies Get inactive topic policies on a topic.
NonPersistentTopicApi GetInternalStats Get /non-persistent/{tenant}/{namespace}/{topic}/internalStats Get the internal stats for the topic.
NonPersistentTopicApi GetLastMessageId Get /non-persistent/{tenant}/{namespace}/{topic}/lastMessageId Return the last commit message id of topic
NonPersistentTopicApi GetList Get /non-persistent/{tenant}/{namespace} Get the list of non-persistent topics under a namespace.
NonPersistentTopicApi GetListFromBundle Get /non-persistent/{tenant}/{namespace}/{bundle} Get the list of non-persistent topics under a namespace bundle.
NonPersistentTopicApi GetManagedLedgerInfo Get /non-persistent/{tenant}/{namespace}/{topic}/internal-info Get the stored topic metadata.
NonPersistentTopicApi GetMaxConsumers Get /non-persistent/{tenant}/{namespace}/{topic}/maxConsumers Get maxConsumers config for specified topic.
NonPersistentTopicApi GetMaxConsumersPerSubscription Get /non-persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscription Get max consumers per subscription configuration for specified topic.
NonPersistentTopicApi GetMaxMessageSize Get /non-persistent/{tenant}/{namespace}/{topic}/maxMessageSize Get maxMessageSize config for specified topic.
NonPersistentTopicApi GetMaxProducers Get /non-persistent/{tenant}/{namespace}/{topic}/maxProducers Get maxProducers config for specified topic.
NonPersistentTopicApi GetMaxSubscriptionsPerTopic Get /non-persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopic Get maxSubscriptionsPerTopic config for specified topic.
NonPersistentTopicApi GetMaxUnackedMessagesOnConsumer Get /non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumer Get max unacked messages per consumer config on a topic.
NonPersistentTopicApi GetMaxUnackedMessagesOnSubscription Get /non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscription Get max unacked messages per subscription config on a topic.
NonPersistentTopicApi GetMessageById Get /non-persistent/{tenant}/{namespace}/{topic}/ledger/{ledgerId}/entry/{entryId} Get message by its messageId.
NonPersistentTopicApi GetMessageTTL Get /non-persistent/{tenant}/{namespace}/{topic}/messageTTL Get message TTL in seconds for a topic
NonPersistentTopicApi GetOffloadPolicies Get /non-persistent/{tenant}/{namespace}/{topic}/offloadPolicies Get offload policies on a topic.
NonPersistentTopicApi GetPartitionedMetadata Get /non-persistent/{tenant}/{namespace}/{topic}/partitions Get partitioned topic metadata.
NonPersistentTopicApi GetPartitionedStats Get /non-persistent/{tenant}/{namespace}/{topic}/partitioned-stats Get the stats for the partitioned topic.
NonPersistentTopicApi GetPartitionedTopicList Get /non-persistent/{tenant}/{namespace}/partitioned Get the list of partitioned topics under a namespace.
NonPersistentTopicApi GetPermissionsOnTopic Get /non-persistent/{tenant}/{namespace}/{topic}/permissions Get permissions on a topic.
NonPersistentTopicApi GetPersistence Get /non-persistent/{tenant}/{namespace}/{topic}/persistence Get configuration of persistence policies for specified topic.
NonPersistentTopicApi GetPublishRate Get /non-persistent/{tenant}/{namespace}/{topic}/publishRate Get publish rate configuration for specified topic.
NonPersistentTopicApi GetReplicatorDispatchRate Get /non-persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRate Get replicatorDispatchRate config for specified topic.
NonPersistentTopicApi GetRetention Get /non-persistent/{tenant}/{namespace}/{topic}/retention Get retention configuration for specified topic.
NonPersistentTopicApi GetStats Get /non-persistent/{tenant}/{namespace}/{topic}/stats Get the stats for the topic.
NonPersistentTopicApi GetSubscribeRate Get /non-persistent/{tenant}/{namespace}/{topic}/subscribeRate Get subscribe rate configuration for specified topic.
NonPersistentTopicApi GetSubscriptionDispatchRate Get /non-persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRate Get subscription message dispatch rate configuration for specified topic.
NonPersistentTopicApi GetSubscriptionTypesEnabled Get /non-persistent/{tenant}/{namespace}/{topic}/subscriptionTypesEnabled Get is enable sub type fors specified topic.
NonPersistentTopicApi GetSubscriptions Get /non-persistent/{tenant}/{namespace}/{topic}/subscriptions Get the list of persistent subscriptions for a given topic.
NonPersistentTopicApi GrantPermissionsOnTopic Post /non-persistent/{tenant}/{namespace}/{topic}/permissions/{role} Grant a new permission to a role on a single topic.
NonPersistentTopicApi OffloadStatus Get /non-persistent/{tenant}/{namespace}/{topic}/offload Offload a prefix of a topic to long term storage
NonPersistentTopicApi PeekNthMessage Get /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition} Peek nth message on a topic subscription.
NonPersistentTopicApi RemoveBacklogQuota Delete /non-persistent/{tenant}/{namespace}/{topic}/backlogQuota Remove a backlog quota policy from a topic.
NonPersistentTopicApi RemoveCompactionThreshold Delete /non-persistent/{tenant}/{namespace}/{topic}/compactionThreshold Remove compaction threshold configuration for specified topic.
NonPersistentTopicApi RemoveDeduplication Delete /non-persistent/{tenant}/{namespace}/{topic}/deduplicationEnabled Remove deduplication configuration for specified topic.
NonPersistentTopicApi RemoveDispatchRate Delete /non-persistent/{tenant}/{namespace}/{topic}/dispatchRate Remove message dispatch rate configuration for specified topic.
NonPersistentTopicApi RemoveMaxConsumers Delete /non-persistent/{tenant}/{namespace}/{topic}/maxConsumers Remove maxConsumers config for specified topic.
NonPersistentTopicApi RemoveMaxConsumersPerSubscription Delete /non-persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscription Remove max consumers per subscription configuration for specified topic.
NonPersistentTopicApi RemoveMaxMessageSize Delete /non-persistent/{tenant}/{namespace}/{topic}/maxMessageSize Remove maxMessageSize config for specified topic.
NonPersistentTopicApi RemoveMaxProducers Delete /non-persistent/{tenant}/{namespace}/{topic}/maxProducers Remove maxProducers config for specified topic.
NonPersistentTopicApi RemoveMaxSubscriptionsPerTopic Delete /non-persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopic Remove maxSubscriptionsPerTopic config for specified topic.
NonPersistentTopicApi RemoveMessageTTL Delete /non-persistent/{tenant}/{namespace}/{topic}/messageTTL Remove message TTL in seconds for a topic
NonPersistentTopicApi RemoveOffloadPolicies Delete /non-persistent/{tenant}/{namespace}/{topic}/offloadPolicies Delete offload policies on a topic.
NonPersistentTopicApi RemovePersistence Delete /non-persistent/{tenant}/{namespace}/{topic}/persistence Remove configuration of persistence policies for specified topic.
NonPersistentTopicApi RemovePublishRate Delete /non-persistent/{tenant}/{namespace}/{topic}/publishRate Remove message publish rate configuration for specified topic.
NonPersistentTopicApi RemoveReplicatorDispatchRate Delete /non-persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRate Remove replicatorDispatchRate config for specified topic.
NonPersistentTopicApi RemoveRetention Delete /non-persistent/{tenant}/{namespace}/{topic}/retention Remove retention configuration for specified topic.
NonPersistentTopicApi RemoveSubscribeRate Delete /non-persistent/{tenant}/{namespace}/{topic}/subscribeRate Remove subscribe rate configuration for specified topic.
NonPersistentTopicApi RemoveSubscriptionDispatchRate Delete /non-persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRate Remove subscription message dispatch rate configuration for specified topic.
NonPersistentTopicApi ResetCursor Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp} Reset subscription to message position closest to absolute timestamp (in ms).
NonPersistentTopicApi ResetCursorOnPosition Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor Reset subscription to message position closest to given position.
NonPersistentTopicApi RevokePermissionsOnTopic Delete /non-persistent/{tenant}/{namespace}/{topic}/permissions/{role} Revoke permissions on a topic.
NonPersistentTopicApi SetBacklogQuota Post /non-persistent/{tenant}/{namespace}/{topic}/backlogQuota Set a backlog quota for a topic.
NonPersistentTopicApi SetCompactionThreshold Post /non-persistent/{tenant}/{namespace}/{topic}/compactionThreshold Set compaction threshold configuration for specified topic.
NonPersistentTopicApi SetDeduplication Post /non-persistent/{tenant}/{namespace}/{topic}/deduplicationEnabled Set deduplication enabled on a topic.
NonPersistentTopicApi SetDeduplicationSnapshotInterval Post /non-persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotInterval Set deduplicationSnapshotInterval config on a topic.
NonPersistentTopicApi SetDelayedDeliveryPolicies Post /non-persistent/{tenant}/{namespace}/{topic}/delayedDelivery Set delayed delivery messages config on a topic.
NonPersistentTopicApi SetDispatchRate Post /non-persistent/{tenant}/{namespace}/{topic}/dispatchRate Set message dispatch rate configuration for specified topic.
NonPersistentTopicApi SetInactiveTopicPolicies Post /non-persistent/{tenant}/{namespace}/{topic}/inactiveTopicPolicies Set inactive topic policies on a topic.
NonPersistentTopicApi SetMaxConsumers Post /non-persistent/{tenant}/{namespace}/{topic}/maxConsumers Set maxConsumers config for specified topic.
NonPersistentTopicApi SetMaxConsumersPerSubscription Post /non-persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscription Set max consumers per subscription configuration for specified topic.
NonPersistentTopicApi SetMaxMessageSize Post /non-persistent/{tenant}/{namespace}/{topic}/maxMessageSize Set maxMessageSize config for specified topic.
NonPersistentTopicApi SetMaxProducers Post /non-persistent/{tenant}/{namespace}/{topic}/maxProducers Set maxProducers config for specified topic.
NonPersistentTopicApi SetMaxSubscriptionsPerTopic Post /non-persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopic Set maxSubscriptionsPerTopic config for specified topic.
NonPersistentTopicApi SetMaxUnackedMessagesOnConsumer Post /non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumer Set max unacked messages per consumer config on a topic.
NonPersistentTopicApi SetMaxUnackedMessagesOnSubscription Post /non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscription Set max unacked messages per subscription config on a topic.
NonPersistentTopicApi SetMessageTTL Post /non-persistent/{tenant}/{namespace}/{topic}/messageTTL Set message TTL in seconds for a topic
NonPersistentTopicApi SetOffloadPolicies Post /non-persistent/{tenant}/{namespace}/{topic}/offloadPolicies Set offload policies on a topic.
NonPersistentTopicApi SetPersistence Post /non-persistent/{tenant}/{namespace}/{topic}/persistence Set configuration of persistence policies for specified topic.
NonPersistentTopicApi SetPublishRate Post /non-persistent/{tenant}/{namespace}/{topic}/publishRate Set message publish rate configuration for specified topic.
NonPersistentTopicApi SetReplicatedSubscriptionStatus Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/replicatedSubscriptionStatus Enable or disable a replicated subscription on a topic.
NonPersistentTopicApi SetReplicatorDispatchRate Post /non-persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRate Set replicatorDispatchRate config for specified topic.
NonPersistentTopicApi SetRetention Post /non-persistent/{tenant}/{namespace}/{topic}/retention Set retention configuration for specified topic.
NonPersistentTopicApi SetSubscribeRate Post /non-persistent/{tenant}/{namespace}/{topic}/subscribeRate Set subscribe rate configuration for specified topic.
NonPersistentTopicApi SetSubscriptionDispatchRate Post /non-persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRate Set subscription message dispatch rate configuration for specified topic.
NonPersistentTopicApi SetSubscriptionTypesEnabled Post /non-persistent/{tenant}/{namespace}/{topic}/subscriptionTypesEnabled Set is enable sub types for specified topic
NonPersistentTopicApi SkipAllMessages Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_all Skip all messages on a topic subscription.
NonPersistentTopicApi SkipMessages Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages} Skipping messages on a topic subscription.
NonPersistentTopicApi 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 TerminatePartitionedTopic Post /non-persistent/{tenant}/{namespace}/{topic}/terminate/partitions Terminate 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
NonPersistentTopicApi TriggerOffload Put /non-persistent/{tenant}/{namespace}/{topic}/offload Offload a prefix of a topic to long term storage
NonPersistentTopicApi TruncateTopic Delete /non-persistent/{tenant}/{namespace}/{topic}/truncate Truncate a topic.
NonPersistentTopicApi UnloadTopic Put /non-persistent/{tenant}/{namespace}/{topic}/unload Unload a topic
NonPersistentTopicApi UpdatePartitionedTopic Post /non-persistent/{tenant}/{namespace}/{topic}/partitions Increment partitions of an existing partitioned topic.
PersistentTopicApi Compact Put /persistent/{tenant}/{namespace}/{topic}/compaction Trigger a compaction operation on a topic.
PersistentTopicApi CompactionStatus Get /persistent/{tenant}/{namespace}/{topic}/compaction Get the status of a compaction operation for a topic.
PersistentTopicApi CreateMissedPartitions Post /persistent/{tenant}/{namespace}/{topic}/createMissedPartitions Create missed partitions of an existing partitioned topic.
PersistentTopicApi CreateNonPartitionedTopic Put /persistent/{tenant}/{namespace}/{topic} Create a non-partitioned topic.
PersistentTopicApi CreatePartitionedTopic Put /persistent/{tenant}/{namespace}/{topic}/partitions Create a partitioned topic.
PersistentTopicApi CreateSubscription Put /persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName} Create a subscription on the topic.
PersistentTopicApi DeleteDeduplicationSnapshotInterval Delete /persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotInterval Delete deduplicationSnapshotInterval config on a topic.
PersistentTopicApi DeleteDelayedDeliveryPolicies Delete /persistent/{tenant}/{namespace}/{topic}/delayedDelivery Set delayed delivery messages config on a topic.
PersistentTopicApi DeleteInactiveTopicPolicies Delete /persistent/{tenant}/{namespace}/{topic}/inactiveTopicPolicies Delete inactive topic policies on a topic.
PersistentTopicApi DeleteMaxUnackedMessagesOnConsumer Delete /persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumer Delete max unacked messages per consumer config on a topic.
PersistentTopicApi DeleteMaxUnackedMessagesOnSubscription Delete /persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscription Delete max unacked messages per subscription config on a topic.
PersistentTopicApi DeletePartitionedTopic Delete /persistent/{tenant}/{namespace}/{topic}/partitions Delete a partitioned topic.
PersistentTopicApi DeleteSubscription Delete /persistent/{tenant}/{namespace}/{topic}/subscription/{subName} Delete a subscription.
PersistentTopicApi DeleteTopic Delete /persistent/{tenant}/{namespace}/{topic} Delete a topic.
PersistentTopicApi ExamineMessage Get /persistent/{tenant}/{namespace}/{topic}/examinemessage Examine a specific message on a topic by position relative to the earliest or the latest message.
PersistentTopicApi ExpireMessagesForAllSubscriptions Post /persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds} Expiry messages on all subscriptions of topic.
PersistentTopicApi ExpireTopicMessages Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages Expiry messages on a topic subscription.
PersistentTopicApi ExpireTopicMessages_0 Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds} Expiry messages on a topic subscription.
PersistentTopicApi GetBacklog Get /persistent/{tenant}/{namespace}/{topic}/backlog Get estimated backlog for offline topic.
PersistentTopicApi GetBacklogQuotaMap Get /persistent/{tenant}/{namespace}/{topic}/backlogQuotaMap Get backlog quota map on a topic.
PersistentTopicApi GetCompactionThreshold Get /persistent/{tenant}/{namespace}/{topic}/compactionThreshold Get compaction threshold configuration for specified topic.
PersistentTopicApi GetDeduplication Get /persistent/{tenant}/{namespace}/{topic}/deduplicationEnabled Get deduplication configuration of a topic.
PersistentTopicApi GetDeduplicationSnapshotInterval Get /persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotInterval Get deduplicationSnapshotInterval config on a topic.
PersistentTopicApi GetDelayedDeliveryPolicies Get /persistent/{tenant}/{namespace}/{topic}/delayedDelivery Get delayed delivery messages config on a topic.
PersistentTopicApi GetDispatchRate Get /persistent/{tenant}/{namespace}/{topic}/dispatchRate Get dispatch rate configuration for specified topic.
PersistentTopicApi GetInactiveTopicPolicies Get /persistent/{tenant}/{namespace}/{topic}/inactiveTopicPolicies Get inactive topic policies on a topic.
PersistentTopicApi GetInternalStats Get /persistent/{tenant}/{namespace}/{topic}/internalStats Get the internal stats for the topic.
PersistentTopicApi GetLastMessageId Get /persistent/{tenant}/{namespace}/{topic}/lastMessageId Return the last commit message id of topic
PersistentTopicApi GetList Get /persistent/{tenant}/{namespace} Get the list of topics under a namespace.
PersistentTopicApi GetManagedLedgerInfo Get /persistent/{tenant}/{namespace}/{topic}/internal-info Get the stored topic metadata.
PersistentTopicApi GetMaxConsumers Get /persistent/{tenant}/{namespace}/{topic}/maxConsumers Get maxConsumers config for specified topic.
PersistentTopicApi GetMaxConsumersPerSubscription Get /persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscription Get max consumers per subscription configuration for specified topic.
PersistentTopicApi GetMaxMessageSize Get /persistent/{tenant}/{namespace}/{topic}/maxMessageSize Get maxMessageSize config for specified topic.
PersistentTopicApi GetMaxProducers Get /persistent/{tenant}/{namespace}/{topic}/maxProducers Get maxProducers config for specified topic.
PersistentTopicApi GetMaxSubscriptionsPerTopic Get /persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopic Get maxSubscriptionsPerTopic config for specified topic.
PersistentTopicApi GetMaxUnackedMessagesOnConsumer Get /persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumer Get max unacked messages per consumer config on a topic.
PersistentTopicApi GetMaxUnackedMessagesOnSubscription Get /persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscription Get max unacked messages per subscription config on a topic.
PersistentTopicApi GetMessageById Get /persistent/{tenant}/{namespace}/{topic}/ledger/{ledgerId}/entry/{entryId} Get message by its messageId.
PersistentTopicApi GetMessageTTL Get /persistent/{tenant}/{namespace}/{topic}/messageTTL Get message TTL in seconds for a topic
PersistentTopicApi GetOffloadPolicies Get /persistent/{tenant}/{namespace}/{topic}/offloadPolicies Get offload policies on a topic.
PersistentTopicApi GetPartitionedMetadata Get /persistent/{tenant}/{namespace}/{topic}/partitions Get partitioned topic metadata.
PersistentTopicApi GetPartitionedStats Get /persistent/{tenant}/{namespace}/{topic}/partitioned-stats Get the stats for the partitioned topic.
PersistentTopicApi GetPartitionedTopicList Get /persistent/{tenant}/{namespace}/partitioned Get the list of partitioned topics under a namespace.
PersistentTopicApi GetPermissionsOnTopic Get /persistent/{tenant}/{namespace}/{topic}/permissions Get permissions on a topic.
PersistentTopicApi GetPersistence Get /persistent/{tenant}/{namespace}/{topic}/persistence Get configuration of persistence policies for specified topic.
PersistentTopicApi GetPublishRate Get /persistent/{tenant}/{namespace}/{topic}/publishRate Get publish rate configuration for specified topic.
PersistentTopicApi GetReplicatorDispatchRate Get /persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRate Get replicatorDispatchRate config for specified topic.
PersistentTopicApi GetRetention Get /persistent/{tenant}/{namespace}/{topic}/retention Get retention configuration for specified topic.
PersistentTopicApi GetStats Get /persistent/{tenant}/{namespace}/{topic}/stats Get the stats for the topic.
PersistentTopicApi GetSubscribeRate Get /persistent/{tenant}/{namespace}/{topic}/subscribeRate Get subscribe rate configuration for specified topic.
PersistentTopicApi GetSubscriptionDispatchRate Get /persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRate Get subscription message dispatch rate configuration for specified topic.
PersistentTopicApi GetSubscriptionTypesEnabled Get /persistent/{tenant}/{namespace}/{topic}/subscriptionTypesEnabled Get is enable sub type fors specified topic.
PersistentTopicApi GetSubscriptions Get /persistent/{tenant}/{namespace}/{topic}/subscriptions Get the list of persistent subscriptions for a given topic.
PersistentTopicApi GrantPermissionsOnTopic Post /persistent/{tenant}/{namespace}/{topic}/permissions/{role} Grant a new permission to a role on a single topic.
PersistentTopicApi OffloadStatus Get /persistent/{tenant}/{namespace}/{topic}/offload Offload a prefix of a topic to long term storage
PersistentTopicApi PeekNthMessage Get /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition} Peek nth message on a topic subscription.
PersistentTopicApi RemoveBacklogQuota Delete /persistent/{tenant}/{namespace}/{topic}/backlogQuota Remove a backlog quota policy from a topic.
PersistentTopicApi RemoveCompactionThreshold Delete /persistent/{tenant}/{namespace}/{topic}/compactionThreshold Remove compaction threshold configuration for specified topic.
PersistentTopicApi RemoveDeduplication Delete /persistent/{tenant}/{namespace}/{topic}/deduplicationEnabled Remove deduplication configuration for specified topic.
PersistentTopicApi RemoveDispatchRate Delete /persistent/{tenant}/{namespace}/{topic}/dispatchRate Remove message dispatch rate configuration for specified topic.
PersistentTopicApi RemoveMaxConsumers Delete /persistent/{tenant}/{namespace}/{topic}/maxConsumers Remove maxConsumers config for specified topic.
PersistentTopicApi RemoveMaxConsumersPerSubscription Delete /persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscription Remove max consumers per subscription configuration for specified topic.
PersistentTopicApi RemoveMaxMessageSize Delete /persistent/{tenant}/{namespace}/{topic}/maxMessageSize Remove maxMessageSize config for specified topic.
PersistentTopicApi RemoveMaxProducers Delete /persistent/{tenant}/{namespace}/{topic}/maxProducers Remove maxProducers config for specified topic.
PersistentTopicApi RemoveMaxSubscriptionsPerTopic Delete /persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopic Remove maxSubscriptionsPerTopic config for specified topic.
PersistentTopicApi RemoveMessageTTL Delete /persistent/{tenant}/{namespace}/{topic}/messageTTL Remove message TTL in seconds for a topic
PersistentTopicApi RemoveOffloadPolicies Delete /persistent/{tenant}/{namespace}/{topic}/offloadPolicies Delete offload policies on a topic.
PersistentTopicApi RemovePersistence Delete /persistent/{tenant}/{namespace}/{topic}/persistence Remove configuration of persistence policies for specified topic.
PersistentTopicApi RemovePublishRate Delete /persistent/{tenant}/{namespace}/{topic}/publishRate Remove message publish rate configuration for specified topic.
PersistentTopicApi RemoveReplicatorDispatchRate Delete /persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRate Remove replicatorDispatchRate config for specified topic.
PersistentTopicApi RemoveRetention Delete /persistent/{tenant}/{namespace}/{topic}/retention Remove retention configuration for specified topic.
PersistentTopicApi RemoveSubscribeRate Delete /persistent/{tenant}/{namespace}/{topic}/subscribeRate Remove subscribe rate configuration for specified topic.
PersistentTopicApi RemoveSubscriptionDispatchRate Delete /persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRate Remove subscription message dispatch rate configuration for specified topic.
PersistentTopicApi ResetCursor Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp} Reset subscription to message position closest to absolute timestamp (in ms).
PersistentTopicApi ResetCursorOnPosition Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor Reset subscription to message position closest to given position.
PersistentTopicApi RevokePermissionsOnTopic Delete /persistent/{tenant}/{namespace}/{topic}/permissions/{role} Revoke permissions on a topic.
PersistentTopicApi SetBacklogQuota Post /persistent/{tenant}/{namespace}/{topic}/backlogQuota Set a backlog quota for a topic.
PersistentTopicApi SetCompactionThreshold Post /persistent/{tenant}/{namespace}/{topic}/compactionThreshold Set compaction threshold configuration for specified topic.
PersistentTopicApi SetDeduplication Post /persistent/{tenant}/{namespace}/{topic}/deduplicationEnabled Set deduplication enabled on a topic.
PersistentTopicApi SetDeduplicationSnapshotInterval Post /persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotInterval Set deduplicationSnapshotInterval config on a topic.
PersistentTopicApi SetDelayedDeliveryPolicies Post /persistent/{tenant}/{namespace}/{topic}/delayedDelivery Set delayed delivery messages config on a topic.
PersistentTopicApi SetDispatchRate Post /persistent/{tenant}/{namespace}/{topic}/dispatchRate Set message dispatch rate configuration for specified topic.
PersistentTopicApi SetInactiveTopicPolicies Post /persistent/{tenant}/{namespace}/{topic}/inactiveTopicPolicies Set inactive topic policies on a topic.
PersistentTopicApi SetMaxConsumers Post /persistent/{tenant}/{namespace}/{topic}/maxConsumers Set maxConsumers config for specified topic.
PersistentTopicApi SetMaxConsumersPerSubscription Post /persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscription Set max consumers per subscription configuration for specified topic.
PersistentTopicApi SetMaxMessageSize Post /persistent/{tenant}/{namespace}/{topic}/maxMessageSize Set maxMessageSize config for specified topic.
PersistentTopicApi SetMaxProducers Post /persistent/{tenant}/{namespace}/{topic}/maxProducers Set maxProducers config for specified topic.
PersistentTopicApi SetMaxSubscriptionsPerTopic Post /persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopic Set maxSubscriptionsPerTopic config for specified topic.
PersistentTopicApi SetMaxUnackedMessagesOnConsumer Post /persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumer Set max unacked messages per consumer config on a topic.
PersistentTopicApi SetMaxUnackedMessagesOnSubscription Post /persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscription Set max unacked messages per subscription config on a topic.
PersistentTopicApi SetMessageTTL Post /persistent/{tenant}/{namespace}/{topic}/messageTTL Set message TTL in seconds for a topic
PersistentTopicApi SetOffloadPolicies Post /persistent/{tenant}/{namespace}/{topic}/offloadPolicies Set offload policies on a topic.
PersistentTopicApi SetPersistence Post /persistent/{tenant}/{namespace}/{topic}/persistence Set configuration of persistence policies for specified topic.
PersistentTopicApi SetPublishRate Post /persistent/{tenant}/{namespace}/{topic}/publishRate Set message publish rate configuration for specified topic.
PersistentTopicApi SetReplicatedSubscriptionStatus Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/replicatedSubscriptionStatus Enable or disable a replicated subscription on a topic.
PersistentTopicApi SetReplicatorDispatchRate Post /persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRate Set replicatorDispatchRate config for specified topic.
PersistentTopicApi SetRetention Post /persistent/{tenant}/{namespace}/{topic}/retention Set retention configuration for specified topic.
PersistentTopicApi SetSubscribeRate Post /persistent/{tenant}/{namespace}/{topic}/subscribeRate Set subscribe rate configuration for specified topic.
PersistentTopicApi SetSubscriptionDispatchRate Post /persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRate Set subscription message dispatch rate configuration for specified topic.
PersistentTopicApi SetSubscriptionTypesEnabled Post /persistent/{tenant}/{namespace}/{topic}/subscriptionTypesEnabled Set is enable sub types for specified topic
PersistentTopicApi SkipAllMessages Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_all Skip all messages on a topic subscription.
PersistentTopicApi SkipMessages Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages} Skipping messages on a topic subscription.
PersistentTopicApi 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 TerminatePartitionedTopic Post /persistent/{tenant}/{namespace}/{topic}/terminate/partitions Terminate 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
PersistentTopicApi TriggerOffload Put /persistent/{tenant}/{namespace}/{topic}/offload Offload a prefix of a topic to long term storage
PersistentTopicApi TruncateTopic Delete /persistent/{tenant}/{namespace}/{topic}/truncate Truncate a topic.
PersistentTopicApi UnloadTopic Put /persistent/{tenant}/{namespace}/{topic}/unload Unload a topic
PersistentTopicApi UpdatePartitionedTopic Post /persistent/{tenant}/{namespace}/{topic}/partitions Increment partitions of an existing partitioned topic.
ResourceQuotasApi GetDefaultResourceQuota Get /resource-quotas Get the default quota
ResourceQuotasApi GetNamespaceBundleResourceQuota Get /resource-quotas/{tenant}/{namespace}/{bundle} Get resource quota of a namespace bundle.
ResourceQuotasApi RemoveNamespaceBundleResourceQuota Delete /resource-quotas/{tenant}/{namespace}/{bundle} Remove resource quota for a namespace.
ResourceQuotasApi SetDefaultResourceQuota Post /resource-quotas Set the default quota
ResourceQuotasApi SetNamespaceBundleResourceQuota Post /resource-quotas/{tenant}/{namespace}/{bundle} Set resource quota on a namespace.
ResourcegroupsApi CreateOrUpdateResourceGroup Put /resourcegroups/{resourcegroup} Creates a new resourcegroup with the specified rate limiters
ResourcegroupsApi DeleteResourceGroup Delete /resourcegroups/{resourcegroup} Delete a resourcegroup.
ResourcegroupsApi GetResourceGroup Get /resourcegroups/{resourcegroup} Get the rate limiters specified for a resourcegroup.
ResourcegroupsApi GetResourceGroups Get /resourcegroups Get the list of all the resourcegroups.
SchemasApi DeleteSchema Delete /schemas/{tenant}/{namespace}/{topic}/schema Delete the schema of a topic
SchemasApi GetAllSchemas Get /schemas/{tenant}/{namespace}/{topic}/schemas Get the all schemas of a topic
SchemasApi GetSchema Get /schemas/{tenant}/{namespace}/{topic}/schema Get the schema of a topic
SchemasApi GetSchema_0 Get /schemas/{tenant}/{namespace}/{topic}/schema/{version} Get the schema of a topic at a given version
SchemasApi GetVersionBySchema Post /schemas/{tenant}/{namespace}/{topic}/version get the version of the schema
SchemasApi PostSchema Post /schemas/{tenant}/{namespace}/{topic}/schema Update the schema of a topic
SchemasApi TestCompatibility Post /schemas/{tenant}/{namespace}/{topic}/compatibility test the schema compatibility
TenantsApi CreateTenant Put /tenants/{tenant} Create a new tenant.
TenantsApi DeleteTenant Delete /tenants/{tenant} Delete a tenant and all namespaces and topics under it.
TenantsApi GetTenantAdmin Get /tenants/{tenant} Get the admin configuration for a given tenant.
TenantsApi GetTenants Get /tenants Get the list of existing tenants.
TenantsApi UpdateTenant Post /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

About

Languages

Language:Shell 100.0%